solaris-utmpx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bea80841580cccc83697be3b85853852a04fc799
+  data.tar.gz: a23e1f074cd99fbe8b488827deddfbafaed497dc
+SHA512:
+  metadata.gz: df97be060d9ced25a54d277008531a3912243d14147b85b93b8e6340b5cd64267359fa93b4ff744e5e6b97f5a2af3a05a7198d3af1a90baef89ae0a7afb2abdb
+  data.tar.gz: 506f30185ec4434791475c8af09a515e500e3851cc83915109f6bd6f78164cef1724f4e1a70405e14b7f79d3fff8c121a974ca34f5553d6ac64661e58244f34e

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2013 Martin Carpenter. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Martin Carpenter ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Martin Carpenter OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Martin Carpenter.
+

data/README.rdoc

@@ -0,0 +1,34 @@
+
+= solaris-utmpx
+
+Author:: Martin Carpenter
+Email:: mcarpenter@free.fr
+Copyright:: Copyright (c) Martin Carpenter 2013
+
+== About
+The solaris-utmpx gem helps with the reading and writing of Solaris
+binary utmpx(4) and wtmpx(4) files.
+
+== Examples
+
+=== Read and display all records in wtmpx
+
+    require 'solaris/utmpx'
+
+    io = File.open('/var/adm/wtmpx', 'r')
+    reader = Solaris::Wtmpx.new(:endian => :little)
+    while !io.eof? do
+      puts reader.read(io)
+    end
+
+=== Filter all root entries from wtmpx
+
+    require 'solaris/utmpx'
+
+    io = File.open('/var/adm/wtmpx', 'r')
+    reader = Solaris::Wtmpx.new(:endian => :little)
+    while !io.eof? do
+      record = reader.read(io)
+      print record.to_binary_s unless record.ut_user == 'root'
+    end
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+desc 'Default task (package)'
+task :default => [:package]
+
+Rake::TestTask.new( 'test' )
+
+SPECFILE = 'solaris-utmpx.gemspec'
+if File.exist?( SPECFILE )
+  spec = eval( File.read( SPECFILE ) )
+  Gem::PackageTask.new( spec ).define
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'solaris-utmpx'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.options << '--main' << 'README.rdoc'
+  rdoc.options << '--all'
+  rdoc.rdoc_files.include( 'README.rdoc' )
+  rdoc.rdoc_files.include( FileList[ 'lib/**/*.rb' ] )
+  rdoc.rdoc_files.include( FileList[ 'test/**/*.rb' ] )
+end
+

data/examples/filter_root.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'solaris/utmpx'
+
+io = File.open(ARGV[0], 'r')
+reader = Solaris::Utmpx.new(:endian => :little)
+while !io.eof? do
+  record = reader.read(io)
+  print record.to_binary_s unless record.ut_user == 'root'
+end
+

data/examples/wtmpx.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'solaris/utmpx'
+
+io = File.open(ARGV[0], 'r')
+reader = Solaris::Utmpx.new(:endian => :little)
+while !io.eof? do
+  puts reader.read(io)
+end
+

data/lib/solaris.rb

@@ -0,0 +1,7 @@
+
+# Namespace for child classes.
+module Solaris
+
+  require 'solaris/utmpx'
+
+end

data/lib/solaris/utmpx.rb

@@ -0,0 +1,113 @@
+
+require 'bindata'
+
+module Solaris
+
+  # See "struct futmpx" in /usr/include/utmpx.h:
+  #
+  #     struct futmpx {
+  #         char    ut_user[32];        /* user login name */
+  #         char    ut_id[4];       /* inittab id */
+  #         char    ut_line[32];        /* device name (console, lnxx) */
+  #         pid32_t ut_pid;         /* process id */
+  #         int16_t ut_type;        /* type of entry */
+  #         struct {
+  #             int16_t e_termination;  /* process termination status */
+  #             int16_t e_exit;     /* process exit status */
+  #         } ut_exit;          /* exit status of a process */
+  #         struct timeval32 ut_tv;     /* time entry was made */
+  #         int32_t ut_session;     /* session ID, user for windowing */
+  #         int32_t pad[5];         /* reserved for future use */
+  #         int16_t ut_syslen;      /* significant length of ut_host */
+  #         char    ut_host[257];       /* remote host name */
+  #     };
+  #
+  class Utmpx < BinData::Record
+
+    # The (anonymous) class of generated records.
+    attr_reader :record_class
+
+    # Length of a raw utmpx record in bytes.
+    RECORD_LENGTH = 372
+
+    # Create a new Utmpx factory object. Options are:
+    # * :endian -- mandatory, set to :big (SPARC) or :little (i386)
+    # * :trim_padding -- trim terminating nulls from read strings
+    # This will generate objects that are subclasses of BinData::Record.
+    def initialize(opts)
+
+      endianism = nil
+      trim_padding = true
+      opts.each do |key, value|
+        case key
+        when :endian
+          endianism = value
+        when :trim_padding
+          trim_padding = value
+        else
+          raise ArgumentError, "Unknown option #{key.inspect}"
+        end
+      end
+
+      @record_class = Class.new(BinData::Record) do
+
+        endian endianism
+
+        string :ut_user, :length => 32, :trim_padding => trim_padding
+        string :ut_id, :length => 4, :trim_padding => trim_padding
+        string :ut_line, :length => 32, :trim_padding => trim_padding
+        uint32 :ut_pid
+        uint16 :ut_type
+        string :pad_word1, :length => 2 # align to 4 byte words
+        uint16 :ut_termination
+        uint16 :ut_exit
+        uint32 :ut_tv_sec
+        uint32 :ut_tv_usec
+        uint32 :ut_session
+        uint32 :pad0
+        uint32 :pad1
+        uint32 :pad2
+        uint32 :pad3
+        uint32 :pad4
+        uint16 :ut_syslen
+        string :ut_host, :length => 257, :trim_padding => trim_padding
+        string :pad_word2, :length => 1 # align to 4 byte words
+
+        # Return the timestamp of this record as a Time object in the local TZ.
+        def localtime
+          Time.at(self.ut_tv_sec + self.ut_tv_usec / 1_000_000.0)
+        end
+
+      end
+
+    end
+
+    # Create a new record. Interesting option keys are:
+    # * :ut_user
+    # * :ut_id
+    # * :ut_line
+    # * :ut_pid
+    # * :ut_type
+    # * :ut_termination
+    # * :ut_exit
+    # * :ut_tv_sec
+    # * :ut_tv_usec
+    # * :ut_session
+    # * :ut_syslen
+    # * :ut_host
+    def create(opts={})
+      # BinData silently discards unknown fields so we check.
+      unknown_fields = opts.keys - self.record_class.fields.fields.map(&:name)
+      raise ArgumentError, "Unknown fields #{unknown_fields.inspect}" unless unknown_fields.empty?
+      @record_class.new(opts)
+    end
+
+    # Read a utmpx record from the given IO object.
+    def read(io)
+      @record_class.read(io)
+    end
+
+  end # Utmpx
+
+end # Solaris
+

data/test/test_create.rb

@@ -0,0 +1,45 @@
+
+require 'test/unit'
+require 'solaris/utmpx'
+
+class TestCreate < Test::Unit::TestCase #:nodoc:
+
+  def test_create
+    utmpx = Solaris::Utmpx.new(:endian => :big)
+    record = utmpx.create(
+      :ut_user => "root",
+      :ut_id => "co10",
+      :ut_line => "console",
+      :ut_pid => 1407,
+      :ut_type => 7,
+      :ut_termination => 0,
+      :ut_exit => 53726,
+      :ut_tv_sec => 1297338834,
+      :ut_tv_usec => 0,
+      :ut_session => 0,
+      :ut_syslen => 8,
+      :ut_host => "jupiter"
+    )
+    assert_equal("root", record.ut_user)
+    assert_equal("co10", record.ut_id)
+    assert_equal("console", record.ut_line)
+    assert_equal(1407, record.ut_pid)
+    assert_equal(7, record.ut_type)
+    assert_equal(0, record.ut_termination)
+    assert_equal(53726, record.ut_exit)
+    assert_equal(1297338834, record.ut_tv_sec)
+    assert_equal(0, record.ut_tv_usec)
+    assert_equal(0, record.ut_session)
+    assert_equal(8, record.ut_syslen)
+    assert_equal("jupiter", record.ut_host)
+  end
+
+  def test_create_invalid_fields
+    utmpx = Solaris::Utmpx.new(:endian => :big)
+    assert_raise(ArgumentError) do
+      utmpx.create(:quack => :boom)
+    end
+  end
+
+end # TestCreate
+

data/test/test_utmpx_i386.rb

@@ -0,0 +1,59 @@
+
+require 'test/unit'
+require 'solaris/utmpx'
+
+class TestUtmpxI386 < Test::Unit::TestCase #:nodoc:
+
+  def setup
+    @reader = Solaris::Utmpx.new(:endian => :little)
+    @io = File.open(File.join(File.dirname(__FILE__), 'wtmpx.i386'), 'r')
+    @records = []
+    4.times { @records << @reader.read(@io) }
+  end
+
+  def teardown
+    @io.close
+  end
+
+  def test_read
+    assert_equal("root", @records[3].ut_user)
+    assert_equal("co10", @records[3].ut_id)
+    assert_equal("console", @records[3].ut_line)
+    assert_equal(1407, @records[3].ut_pid)
+    assert_equal(7, @records[3].ut_type)
+    assert_equal(0, @records[3].ut_termination)
+    assert_equal(53726, @records[3].ut_exit)
+    assert_equal(1297338834, @records[3].ut_tv_sec)
+    assert_equal(0, @records[3].ut_tv_usec)
+    assert_equal(0, @records[3].ut_session)
+    assert_equal(0, @records[3].ut_syslen)
+    assert_equal("", @records[3].ut_host)
+  end
+
+  def test_record_length
+    @records.each do |record|
+      assert_equal(Solaris::Utmpx::RECORD_LENGTH, record.to_binary_s.length)
+    end
+  end
+
+  def test_ut_syslen
+    @records.each do |record|
+      # +1 since ut_syslen includes terminating null but only when non-zero
+      if record.ut_syslen == 0
+        assert_equal(record.ut_syslen, record.ut_host.length, "#{record}")
+      else
+        assert_equal(record.ut_syslen, record.ut_host.length + 1, "#{record}")
+      end
+    end
+  end
+
+  def test_to_binary_s
+    @io.rewind
+    @records.each do |record|
+      raw = @io.read(Solaris::Utmpx::RECORD_LENGTH)
+      assert_equal(raw, record.to_binary_s)
+    end
+  end
+
+end # TestUtmpxI386
+

data/test/test_utmpx_sparc.rb

@@ -0,0 +1,59 @@
+
+require 'test/unit'
+require 'solaris/utmpx'
+
+class TestUtmpxSparc < Test::Unit::TestCase #:nodoc:
+
+  def setup
+    @reader = Solaris::Utmpx.new(:endian => :big)
+    @io = File.open(File.join(File.dirname(__FILE__), 'wtmpx.sparc'), 'r')
+    @records = []
+    4.times { @records << @reader.read(@io) }
+  end
+
+  def teardown
+    @io.close
+  end
+
+  def test_read
+    assert_equal("root", @records[3].ut_user)
+    assert_equal("co10", @records[3].ut_id)
+    assert_equal("console", @records[3].ut_line)
+    assert_equal(3944, @records[3].ut_pid)
+    assert_equal(7, @records[3].ut_type)
+    assert_equal(0, @records[3].ut_termination)
+    assert_equal(0, @records[3].ut_exit)
+    assert_equal(1230681969, @records[3].ut_tv_sec)
+    assert_equal(0, @records[3].ut_tv_usec)
+    assert_equal(0, @records[3].ut_session)
+    assert_equal(0, @records[3].ut_syslen)
+    assert_equal("", @records[3].ut_host)
+  end
+
+  def test_record_length
+    @records.each do |record|
+      assert_equal(Solaris::Utmpx::RECORD_LENGTH, record.to_binary_s.length)
+    end
+  end
+
+  def test_ut_syslen
+    @records.each do |record|
+      # +1 since ut_syslen includes terminating null but only when non-zero
+      if record.ut_syslen == 0
+        assert_equal(record.ut_syslen, record.ut_host.length, "#{record}")
+      else
+        assert_equal(record.ut_syslen, record.ut_host.length + 1, "#{record}")
+      end
+    end
+  end
+
+  def test_to_binary_s
+    @io.rewind
+    @records.each do |record|
+      raw = @io.read(Solaris::Utmpx::RECORD_LENGTH)
+      assert_equal(raw, record.to_binary_s)
+    end
+  end
+
+end # TestUtmpxSparc
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: solaris-utmpx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: Read and write Solaris utmpx and wtmpx files
+email: mcarpenter@free.fr
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- Rakefile
+- README.rdoc
+files:
+- examples/filter_root.rb
+- examples/wtmpx.rb
+- lib/solaris.rb
+- lib/solaris/utmpx.rb
+- test/test_create.rb
+- test/test_utmpx_i386.rb
+- test/test_utmpx_sparc.rb
+- test/wtmpx.i386
+- test/wtmpx.sparc
+- LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/mcarpenter/solaris-utmpx
+licenses:
+- BSD
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Read and write Solaris utmpx and wtmpx files
+test_files:
+- test/test_create.rb
+- test/test_utmpx_i386.rb
+- test/test_utmpx_sparc.rb