linux-utmpx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c97e1b42f1cdb52f5e36237a34b1fd9a45725577d40fa95c2dc2af60bac191c7
+  data.tar.gz: 5f4fa12738f051bb224b1122883df78ca18f5825f16913a677cc93d446682101
+SHA512:
+  metadata.gz: 11be5a0e6b534a53d2b9c2f32b2314c671f8fe9afb85977a5d009bcb4290fb3f65f86ef8390c1d9ce54e3ef4657705a638734ee1c1de8d1186149975ddaa3496
+  data.tar.gz: d0f6585ea4fd7a0a43a44b898c9d6b966f136a56605b67164e77e1f6b976cdbcac6cb5de296f2b1c65eb778d93d36063e8c14aac170de9ebc38d9e9bdd60bd71

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+    name: Ruby ${{ matrix.ruby }} unit testing on ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run the default task
+      run: |
+        gem install bundler
+        bundle install
+        TESTOPTS="--verbose" bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in linux-utmpx.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kentaro Hayashi
+
+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,46 @@
+# Linux::Utmpx::UtmpxParser
+
+Helper library to parse /var/log/wtmp, /var/run/utmp.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linux-utmpx'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install linux-utmpx
+
+## Usage
+
+Read all records in `/var/log/wtmp`.
+
+```ruby
+io = File.open("/var/log/wtmp")
+parser = Linux::Utmpx::UtmpxParser.new
+while !io.eof? do
+  puts parser.read(io)
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, 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/fluent-lugins-nursery/linux-utmpx.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "linux/utmpx"
+
+# 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/lib/linux/utmpx.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bindata"
+require_relative "utmpx/version"
+require_relative "utmpx/parser"
+require_relative "utmpx/type"
+
+module Linux
+  module Utmpx
+  end
+end

data/lib/linux/utmpx/parser.rb

@@ -0,0 +1,73 @@
+module Linux
+  module Utmpx
+    # See /usr/include/bits/utmpx.h
+
+    class Exitstatus < BinData::Record
+      endian :little
+      int16 :e_termination
+      int16 :e_exit
+    end
+
+    class Uttv < BinData::Record
+      endian :little
+      int32 :tv_sec
+      int32 :tv_usec
+    end
+
+    class UtmpxParser < BinData::Record
+      UT_LINESIZE = 32
+      UT_NAMESIZE = 32
+      UT_HOSTSIZE = 256
+      UT_IDSIZE = 4
+
+      endian :little
+
+      int16 :ut_type
+      int16 :pad_type # Align
+      int32 :ut_pid
+      string :ut_line, :length => UT_LINESIZE, :trim_padding => true
+      string :ut_id, :length => UT_IDSIZE, :trim_padding => true
+      string :ut_user, :length => UT_NAMESIZE, :trim_padding => true
+      string :ut_host, :length => UT_HOSTSIZE, :trim_padding => true
+      exitstatus :ut_exit
+      int32 :ut_session
+      uttv  :ut_tv
+      array :ut_addr_v6, :initial_length => 4 do
+        int32
+      end
+      string :reserved, :length => 20
+
+      def time
+        Time.at(ut_tv.tv_sec, ut_tv.tv_usec)
+      end
+
+      def type
+        Linux::Utmpx::Type.constants.each do |sym|
+          return sym if Linux::Utmpx::Type.const_get(sym) == ut_type
+        end
+        ut_type
+      end
+
+      def pid
+        ut_pid
+      end
+
+      def line
+        ut_line
+      end
+
+      def user
+        ut_user
+      end
+
+      def id
+        ut_id
+      end
+
+      def host
+        ut_host
+      end
+    end
+
+  end
+end

data/lib/linux/utmpx/type.rb

@@ -0,0 +1,16 @@
+module Linux
+  module Utmpx
+    module Type
+      EMPTY = 0
+      RUN_LVL = 1
+      BOOT_TIME = 2
+      NEW_TIME = 3
+      OLD_TIME = 4
+      INIT_PROCESS = 5
+      LOGIN_PROCESS = 6
+      USER_PROCESS = 7
+      DEAD_PROCESS = 8
+      ACCOUNTING = 9
+    end
+  end
+end

data/lib/linux/utmpx/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Linux
+  module Utmpx
+    VERSION = "0.1.0"
+  end
+end

data/linux-utmpx.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/linux/utmpx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "linux-utmpx"
+  spec.version       = Linux::Utmpx::VERSION
+  spec.authors       = ["Kentaro Hayashi"]
+  spec.email         = ["kenhys@gmail.com"]
+
+  spec.summary       = "Helper library to read utmp, wtmp login records"
+  spec.description   = "Library to read login records from /var/log/wtmp, /var/run/utmp"
+  spec.homepage      = "https://github.com/fluent-plugins-nursery/linux-utmpx"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fluent-plugins-nursery/linux-utmpx"
+  spec.metadata["changelog_uri"] = "https://github.com/fluent-plugins-nursery/linux-utmpx/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "bindata", "~> 2.4.8"
+
+  spec.add_development_dependency "test-unit", "~> 3.4.0"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: linux-utmpx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kentaro Hayashi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.8
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Library to read login records from /var/log/wtmp, /var/run/utmp
+email:
+- kenhys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/linux/utmpx.rb
+- lib/linux/utmpx/parser.rb
+- lib/linux/utmpx/type.rb
+- lib/linux/utmpx/version.rb
+- linux-utmpx.gemspec
+homepage: https://github.com/fluent-plugins-nursery/linux-utmpx
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fluent-plugins-nursery/linux-utmpx
+  source_code_uri: https://github.com/fluent-plugins-nursery/linux-utmpx
+  changelog_uri: https://github.com/fluent-plugins-nursery/linux-utmpx/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Helper library to read utmp, wtmp login records
+test_files: []