solaris-lastlog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a32aafce3d78d5a27ccc119bda3f64a77bd6d84
+  data.tar.gz: 2e299e8826ecfbbb0267251b76a77225ffa6ace7
+SHA512:
+  metadata.gz: 75c104e82828bed23b5b5be98fa5e7288ead6030167d56a79ce1c1f30fddd856af0610c9aad4a703b765bc7bd9196c8a4bc84a2bc068562c5d925045024f8036
+  data.tar.gz: 00a7158310efd66306124570cb405cc4d639c7eb198ac97af9b559dc72a83b2b9547167deb1e5a40aa4d6ceb813eccf1396637dfa27722d8a0d34ac4a70421f4

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,47 @@
+
+= solaris-lastlog
+
+Author:: Martin Carpenter
+Email:: mcarpenter@free.fr
+Copyright:: Copyright (c) Martin Carpenter 2013
+
+== About
+The solaris-lastlog gem helps with the reading and writing of Solaris
+binary lastlog(4) files.
+
+== Examples
+
+See the examples subdirectory.
+
+=== Read and display all non-null entries in the lastlog
+
+    require 'solaris/lastlog'
+
+    io = File.open('/var/adm/lastlog', 'r')
+    reader = Solaris::Lastlog.new(:endian => :little)
+    uid = 0
+    while !io.eof? do
+      record = reader.read(io)
+      unless record.ll_time.zero?
+        time = Time.at(record.ll_time)
+        puts "%-5s %s %-16s %-8s" % [uid, time, record.ll_host, record.ll_line]
+      end
+      uid += 1
+    end
+
+=== Filter the lastlog and set root's last login time to the current time
+
+    require 'solaris/lastlog'
+
+    io = File.open('/var/adm/lastlog', 'r')
+    reader = Solaris::Lastlog.new(:endian => :little)
+    first_record = true
+    while !io.eof? do
+      record = reader.read(io)
+      if first_record
+        first_record = false
+        record.ll_time = Time.now.to_i
+      end
+      print record.to_binary_s
+    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-lastlog.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-lastlog'
+  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/lastlog.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'solaris/lastlog'
+
+io = File.open(ARGV[0], 'r')
+reader = Solaris::Lastlog.new(:endian => :little)
+uid = 0
+while !io.eof? do
+  record = reader.read(io)
+  unless record.ll_time.zero?
+    time = Time.at(record.ll_time)
+    puts "%-5s %s %-16s %-8s" % [uid, time, record.ll_host, record.ll_line]
+  end
+  uid += 1
+end
+

data/examples/set_root_time.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'solaris/lastlog'
+
+io = File.open(ARGV[0], 'r')
+reader = Solaris::Lastlog.new(:endian => :little)
+first_record = true
+while !io.eof? do
+  record = reader.read(io)
+  if first_record
+    record.ll_time = Time.now.to_i
+    first_record = false
+  end
+  print record.to_binary_s
+end
+

data/lib/solaris.rb

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

data/lib/solaris/lastlog.rb

@@ -0,0 +1,82 @@
+
+require 'bindata'
+
+module Solaris
+
+  # See "struct lastlog" in /usr/include/lastlog.h:
+  #
+  #     struct lastlog {
+  #     #ifdef _LP64
+  #         time32_t ll_time;
+  #     #else
+  #         time_t  ll_time;
+  #     #endif
+  #         char    ll_line[8];
+  #         char    ll_host[16];        /* same as in utmp */
+  #     };
+  #
+  class Lastlog
+
+    # The (anonymous) class of generated records.
+    attr_reader :record_class
+
+    # Length of a raw lastlog record in bytes.
+    RECORD_LENGTH = 28
+
+    # Create a new Lastlog 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 of an anonymous class that is a subclass
+    # 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
+
+        uint32 :ll_time
+        string :ll_line, :length => 8, :trim_padding => trim_padding
+        string :ll_host, :length => 16, :trim_padding => trim_padding
+
+        # Return the timestamp of this record as a Time object in the local TZ.
+        def localtime          
+          Time.at(self.ll_time)
+        end                    
+
+      end
+
+    end
+
+    # Create a new record. Option keys are:
+    # * :ll_time
+    # * :ll_line
+    # * :ll_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 lastlog record from the given IO object.
+    def read(io)
+      @record_class.read(io)
+    end
+
+  end # Lastlog
+
+end # Solaris
+

data/test/test_create.rb

@@ -0,0 +1,31 @@
+
+require 'test/unit'
+require 'solaris/lastlog'
+
+class TestCreate < Test::Unit::TestCase #:nodoc:
+
+  def test_create
+    lastlog = Solaris::Lastlog.new(:endian => :big)
+    record = lastlog.create(:ll_time => 1375010633, :ll_host => "neptune", :ll_line => "pts/1")
+    assert_equal(1375010633, record.ll_time)
+    assert_equal("neptune", record.ll_host)
+    assert_equal("pts/1", record.ll_line)
+  end
+
+  def test_create_with_padding
+    lastlog = Solaris::Lastlog.new(:endian => :big, :trim_padding => false)
+    record = lastlog.create(:ll_time => 1375010633, :ll_host => "neptune", :ll_line => "pts/1")
+    assert_equal(1375010633, record.ll_time)
+    assert_equal("neptune\x00\x00\x00\x00\x00\x00\x00\x00\x00", record.ll_host)
+    assert_equal("pts/1\x00\x00\x00", record.ll_line)
+  end
+
+  def test_create_invalid_fields
+    lastlog = Solaris::Lastlog.new(:endian => :big)
+    assert_raise(ArgumentError) do
+      lastlog.create(:quack => :boom)
+    end
+  end
+
+end # TestCreate
+

data/test/test_lastlog_i386.rb

@@ -0,0 +1,64 @@
+
+require 'test/unit'
+require 'solaris/lastlog'
+
+class TestLastlogI386 < Test::Unit::TestCase #:nodoc:
+
+  def setup
+    @reader = Solaris::Lastlog.new(:endian => :little)
+    @io = File.open(File.join(File.dirname(__FILE__), 'lastlog.i386'), 'r')
+    @root_entry = @reader.read(@io)
+  end
+
+  def teardown
+    @io.close
+  end
+
+  def test_read
+    assert_equal(1366318982, @root_entry.ll_time)
+    assert_equal("console", @root_entry.ll_line)
+    assert_equal("jupiter", @root_entry.ll_host)
+    assert_equal(Solaris::Lastlog::RECORD_LENGTH, @root_entry.to_binary_s.length)
+  end
+
+  def test_trim_padding
+    @reader = Solaris::Lastlog.new(:endian => :little, :trim_padding => false)
+    @io.rewind
+    @root_entry = @reader.read(@io)
+    assert_equal(1366318982, @root_entry.ll_time)
+    assert_equal("console\x0", @root_entry.ll_line)
+    assert_equal("jupiter\x0\x0\x0\x0\x0\x0\x0\x0\x0", @root_entry.ll_host)
+  end
+
+  def test_host
+    assert_equal("jupiter", @root_entry.ll_host)
+    @root_entry.ll_host = "host"
+    assert_equal("host", @root_entry.ll_host)
+    @root_entry.ll_host = "12345678901234567" # too long
+    assert_equal("1234567890123456", @root_entry.ll_host)
+  end
+
+  def test_line
+    assert_equal("console", @root_entry.ll_line)
+    @root_entry.ll_line = "line"
+    assert_equal("line", @root_entry.ll_line)
+    assert_equal("line", @root_entry.ll_line)
+    @root_entry.ll_line = "123456789" # too long
+    assert_equal("12345678", @root_entry.ll_line)
+  end
+
+  def test_time
+    assert_equal(Time.at(1366318982).to_i, @root_entry.ll_time)
+    now = Time.now.to_i
+    @root_entry.ll_time = now
+    assert_equal(now, @root_entry.ll_time)
+  end
+
+  def test_to_binary_s
+    @io.rewind
+    raw = @io.read(Solaris::Lastlog::RECORD_LENGTH)
+    assert_equal(raw, @root_entry.to_binary_s)
+  end
+
+end # TestLastlogI386
+

data/test/test_lastlog_sparc.rb

@@ -0,0 +1,64 @@
+
+require 'test/unit'
+require 'solaris/lastlog'
+
+class TestLastlogSparc < Test::Unit::TestCase #:nodoc:
+
+  def setup
+    @reader = Solaris::Lastlog.new(:endian => :big)
+    @io = File.open(File.join(File.dirname(__FILE__), 'lastlog.sparc'), 'r')
+    @root_entry = @reader.read(@io)
+  end
+
+  def teardown
+    @io.close
+  end
+
+  def test_read
+    assert_equal(1375005527, @root_entry.ll_time)
+    assert_equal("console", @root_entry.ll_line)
+    assert_equal("jupiter", @root_entry.ll_host)
+    assert_equal(Solaris::Lastlog::RECORD_LENGTH, @root_entry.to_binary_s.length)
+  end
+
+  def test_trim_padding
+    @reader = Solaris::Lastlog.new(:endian => :big, :trim_padding => false)
+    @io.rewind
+    @root_entry = @reader.read(@io)
+    assert_equal(1375005527, @root_entry.ll_time)
+    assert_equal("console\x0", @root_entry.ll_line)
+    assert_equal("jupiter\x0\x0\x0\x0\x0\x0\x0\x0\x0", @root_entry.ll_host)
+  end
+
+  def test_host
+    assert_equal("jupiter", @root_entry.ll_host)
+    @root_entry.ll_host = "host"
+    assert_equal("host", @root_entry.ll_host)
+    @root_entry.ll_host = "12345678901234567" # too long
+    assert_equal("1234567890123456", @root_entry.ll_host)
+  end
+
+  def test_line
+    assert_equal("console", @root_entry.ll_line)
+    @root_entry.ll_line = "line"
+    assert_equal("line", @root_entry.ll_line)
+    assert_equal("line", @root_entry.ll_line)
+    @root_entry.ll_line = "123456789" # too long
+    assert_equal("12345678", @root_entry.ll_line)
+  end
+
+  def test_time
+    assert_equal(Time.at(1375005527).to_i, @root_entry.ll_time)
+    now = Time.now.to_i
+    @root_entry.ll_time = now
+    assert_equal(now, @root_entry.ll_time)
+  end
+
+  def test_to_binary_s
+    @io.rewind
+    raw = @io.read(Solaris::Lastlog::RECORD_LENGTH)
+    assert_equal(raw, @root_entry.to_binary_s)
+  end
+
+end # TestLastlogSparc
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: solaris-lastlog
+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 lastlog files
+email: mcarpenter@free.fr
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- Rakefile
+- README.rdoc
+files:
+- examples/lastlog.rb
+- examples/set_root_time.rb
+- lib/solaris.rb
+- lib/solaris/lastlog.rb
+- test/lastlog.i386
+- test/lastlog.sparc
+- test/test_create.rb
+- test/test_lastlog_i386.rb
+- test/test_lastlog_sparc.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/mcarpenter/solaris-lastlog
+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 lastlog files
+test_files:
+- test/test_create.rb
+- test/test_lastlog_i386.rb
+- test/test_lastlog_sparc.rb