sys-admin 1.5.6 → 1.6.0

data/lib/sunos/sys/admin.rb

@@ -0,0 +1,241 @@
+require 'sys/admin/custom'
+require 'sys/admin/common'
+
+# The Solaris specific code.
+
+module Sys
+  class Admin
+    private
+
+    # I'm making some aliases here to prevent potential conflicts
+    attach_function :open_c, :open, [:string, :int], :int
+    attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
+    attach_function :close_c, :close, [:int], :int
+
+    attach_function :getlogin_r, [:pointer, :size_t], :pointer
+    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t], :pointer
+    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t], :pointer
+    attach_function :getpwent_r, [:pointer, :pointer, :int], :pointer
+    attach_function :getgrent_r, [:pointer, :pointer, :int], :pointer
+    attach_function :getgrnam_r, [:string, :pointer, :pointer, :int], :pointer
+    attach_function :getgrgid_r, [:long, :pointer, :pointer, :int], :pointer
+
+    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getpwent_r
+    private_class_method :getgrent_r, :getgrnam_r, :getgrgid_r
+    private_class_method :open_c, :pread_c, :close_c
+
+    # struct passwd from /usr/include/pwd.h
+    class PasswdStruct < FFI::Struct
+      layout(
+        :pw_name, :string,
+        :pw_passwd, :string,
+        :pw_uid, :uint,
+        :pw_gid, :uint,
+        :pw_age, :string,
+        :pw_comment, :string,
+        :pw_gecos, :string,
+        :pw_dir, :string,
+        :pw_shell, :string
+      )
+    end
+
+    # struct group from /usr/include/grp.h
+    class GroupStruct < FFI::Struct
+      layout(
+        :gr_name, :string,
+        :gr_passwd, :string,
+        :gr_gid, :uint,
+        :gr_mem, :pointer
+      )
+    end
+
+    # I'm blending the timeval struct in directly here
+    class LastlogStruct < FFI::Struct
+      layout(
+        :ll_time, :uint,
+        :ll_line, [:char, 32],
+        :ll_host, [:char, 256]
+      )
+    end
+
+    public
+
+    # Returns the login for the current process.
+    #
+    def self.get_login
+      buf = FFI::MemoryPointer.new(:char, 256)
+
+      ptr = getlogin_r(buf, buf.size)
+
+      if ptr.null?
+        raise Error, "getlogin_r function failed: " + strerror(FFI.errno)
+      end
+
+      buf.read_string
+    end
+
+    # Returns a User object for the given name or uid. Raises an error
+    # if a user cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_user('joe')
+    #    Sys::Admin.get_user(501)
+    #
+    def self.get_user(uid)
+      buf  = FFI::MemoryPointer.new(:char, 1024)
+      temp = PasswdStruct.new
+
+      if uid.is_a?(String)
+        ptr = getpwnam_r(uid, temp, buf, buf.size)
+      else
+        ptr = getpwuid_r(uid, temp, buf, buf.size)
+      end
+
+      if ptr.null?
+        raise Error, "getpwnam_r or getpwuid_r function failed: " + strerror(FFI.errno)
+      end
+
+      pwd = PasswdStruct.new(ptr)
+      get_user_from_struct(pwd)
+    end
+
+    # Returns a Group object for the given name or uid. Raises an error
+    # if a group cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_group('admin')
+    #    Sys::Admin.get_group(101)
+    #
+    def self.get_group(gid)
+      buf  = FFI::MemoryPointer.new(:char, 1024)
+      temp = GroupStruct.new
+
+      if gid.is_a?(String)
+        ptr = getgrnam_r(gid, temp, buf, buf.size)
+      else
+        ptr = getgrgid_r(gid, temp, buf, buf.size)
+      end
+
+      if ptr.null?
+        raise Error, "getgrnam_r or getgrgid_r function failed: " + strerror(FFI.errno)
+      end
+
+      grp = GroupStruct.new(ptr)
+      get_group_from_struct(grp)
+    end
+
+    # Returns an array of User objects for each user on the system.
+    #
+    def self.users
+      users = []
+
+      buf  = FFI::MemoryPointer.new(:char, 1024)
+      temp = PasswdStruct.new
+
+      begin
+        setpwent()
+
+        while !(ptr = getpwent_r(temp, buf, buf.size)).null?
+          break if ptr.null?
+
+          pwd = PasswdStruct.new(ptr)
+          users << get_user_from_struct(pwd)
+        end
+      ensure
+        endpwent()
+      end
+
+      users
+    end
+
+    # Returns an array of Group objects for each user on the system.
+    #
+    def self.groups
+      groups = []
+
+      buf  = FFI::MemoryPointer.new(:char, 1024)
+      temp = GroupStruct.new
+
+      begin
+        setgrent()
+
+        while !(ptr = getgrent_r(temp, buf, buf.size)).null?
+          break if ptr.null?
+
+          grp = GroupStruct.new(ptr)
+          groups << get_group_from_struct(grp)
+        end
+      ensure
+        endgrent()
+      end
+
+      groups
+    end
+
+    private
+
+    # Takes a GroupStruct and converts it to a Group object.
+    def self.get_group_from_struct(grp)
+      Group.new do |g|
+        g.name    = grp[:gr_name]
+        g.passwd  = grp[:gr_passwd]
+        g.gid     = grp[:gr_gid]
+        g.members = grp[:gr_mem].read_array_of_string
+      end
+    end
+
+    # Takes a UserStruct and converts it to a User object.
+    def self.get_user_from_struct(pwd)
+      user = User.new do |u|
+        u.name         = pwd[:pw_name]
+        u.passwd       = pwd[:pw_passwd]
+        u.uid          = pwd[:pw_uid]
+        u.gid          = pwd[:pw_gid]
+        u.gecos        = pwd[:pw_gecos]
+        u.dir          = pwd[:pw_dir]
+        u.shell        = pwd[:pw_shell]
+      end
+
+      log = get_lastlog_info(user.uid)
+
+      if log
+        login_device = log[:ll_line].to_s
+        login_host   = log[:ll_host].to_s
+
+        user.login_time   = Time.at(log[:ll_time]) if log[:ll_time] > 0
+        user.login_device = login_device unless login_device.empty?
+        user.login_host   = login_host unless login_host.empty?
+      end
+
+      user
+    end
+
+    # The use of pread was necessary here because it's a sparse file. Note
+    # also that while Solaris supports the getuserattr function, it doesn't
+    # appear to store anything regarding login information.
+    #
+    def self.get_lastlog_info(uid)
+      logfile = '/var/adm/lastlog'
+      lastlog = LastlogStruct.new
+
+      begin
+        fd = open_c(logfile, File::RDONLY)
+
+        if fd != -1
+          bytes = pread_c(fd, lastlog, lastlog.size, uid * lastlog.size)
+          if bytes < 0
+            raise Error, "pread function failed: " + strerror(FFI.errno)
+          end
+        else
+          nil # Ignore, improper permissions
+        end
+      ensure
+        close_c(fd) if fd && fd >= 0
+      end
+
+      lastlog
+    end
+  end
+end

data/lib/sys/admin.rb

@@ -0,0 +1,17 @@
+# Stub to require the correct based on platform
+require 'rbconfig'
+
+case RbConfig::CONFIG['host_os']
+  when /linux/i
+    require 'linux/sys/admin'
+  when /sunos|solaris/i
+    require 'sunos/sys/admin'
+  when /cygwin|mingw|mswin|windows|dos/i
+    require 'windows/sys/admin'
+  when /darwin|mach/i
+    require 'darwin/sys/admin'
+  when /bsd/i
+    require 'bsd/sys/admin'
+  else
+    require 'unix/sys/admin'
+end

data/lib/sys/admin/common.rb

@@ -0,0 +1,140 @@
+require 'ffi'
+
+# The Sys module serves as a namespace only.
+module Sys
+
+  # The Admin class provides a unified, cross platform replacement
+  # for the Etc module.
+  class Admin
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    private
+
+    attach_function :strerror, [:int], :string
+
+    attach_function :getlogin, [], :string
+    attach_function :getuid, [], :long
+    attach_function :getpwnam, [:string], :pointer
+    attach_function :getpwuid, [:long], :pointer
+    attach_function :getpwent, [], :pointer
+    attach_function :setpwent, [], :void
+    attach_function :endpwent, [], :void
+
+    attach_function :getgrgid, [:long], :pointer
+    attach_function :getgrnam, [:string], :pointer
+    attach_function :getgrent, [], :pointer
+    attach_function :endgrent, [], :void
+    attach_function :setgrent, [], :void
+
+    private_class_method :getlogin, :getuid, :getpwnam, :getpwuid, :getpwent
+    private_class_method :setpwent, :endpwent, :getgrgid, :getgrnam
+    private_class_method :getgrent, :endgrent, :setgrent, :strerror
+
+    public
+
+    # The version of the sys-admin library.
+    VERSION = '1.6.0'
+
+    # Error typically raised if any of the Sys::Admin methods fail.
+    class Error < StandardError; end
+
+    # The User class encapsulates the information found in /etc/passwd.
+    class User
+      # The user name associated with the account.
+      attr_accessor :name
+
+      # The user's encrypted password. Deprecated by /etc/shadow.
+      attr_accessor :passwd
+
+      # The user's user ID.
+      attr_accessor :uid
+
+      # The user's group ID.
+      attr_accessor :gid
+
+      # Next date a password change will be needed.
+      attr_accessor :change
+
+      # A comment field. Rarely used now.
+      attr_accessor :gecos
+
+      # The user's alloted amount of disk space.
+      attr_accessor :quota
+
+      # The absolute path name of the user's home directory.
+      attr_accessor :dir
+
+      # The user's login shell.
+      attr_accessor :shell
+
+      # The account's expiration date
+      attr_accessor :expire
+
+      # TODO: Forgot what this is.
+      attr_accessor :fields
+
+      # The user's access class.
+      attr_accessor :access_class
+
+      # Another comment field.
+      attr_accessor :comment
+
+      # Used in the past for password aging. Deprecated by /etc/shadow.
+      attr_accessor :age
+
+      # The last time the user logged in.
+      attr_accessor :login_time
+
+      # The host name from which the user last logged in.
+      attr_accessor :login_host
+
+      # The name of the terminal device the user last logged on with.
+      attr_accessor :login_device
+
+      # Creates and returns a User object, which encapsulates the information
+      # typically found within an /etc/passwd entry, i.e. a struct passwd.
+      #
+      # If a block is provided, yields the object back to the block.
+      #
+      def initialize
+        yield self if block_given?
+      end
+
+      # An array of groups to which the user belongs.
+      def groups
+        array = []
+
+        Sys::Admin.groups.each{ |grp|
+          array << grp.name if grp.members.include?(self.name)
+        }
+
+        array
+      end
+    end
+
+    # The Group class encapsulates information found in /etc/group.
+    class Group
+      # The name of the group.
+      attr_accessor :name
+
+      # The group's group ID.
+      attr_accessor :gid
+
+      # An array of members associated with the group.
+      attr_accessor :members
+
+      # The group password, if any.
+      attr_accessor :passwd
+
+      # Creates and returns a Group object, which encapsulates the information
+      # typically found within an /etc/group entry, i.e. a struct group.
+      #
+      # If a block is provided, yields the object back to the block.
+      #
+      def initialize
+        yield self if block_given?
+      end
+    end
+  end
+end

data/lib/sys/admin/custom.rb

@@ -0,0 +1,16 @@
+require 'ffi'
+
+class FFI::Pointer
+  def read_array_of_string
+    elements = []
+
+    loc = self
+
+    until ((element = loc.read_pointer).null?)
+     elements << element.read_string
+     loc += FFI::Type::POINTER.size
+    end
+
+    elements
+  end
+end

data/lib/unix/sys/admin.rb

@@ -0,0 +1,164 @@
+require 'sys/admin/custom'
+require 'sys/admin/common'
+
+# Code used as a fallback for UNIX platforms.
+
+module Sys
+  class Admin
+
+    private
+
+    class PasswdStruct < FFI::Struct
+      layout(
+        :pw_name,   :string,
+        :pw_passwd, :string,
+        :pw_uid,    :uint,
+        :pw_gid,    :uint,
+        :pw_gecos,  :string,
+        :pw_dir,    :string,
+        :pw_shell,  :string
+      )
+    end
+
+    class GroupStruct < FFI::Struct
+      layout(
+        :gr_name,   :string,
+        :gr_passwd, :string,
+        :gr_gid,    :uint,
+        :gr_mem,    :pointer
+      )
+    end
+
+    public
+
+    # Returns the login for the current process.
+    #
+    def self.get_login
+      getlogin()
+    end
+
+    # Returns a User object for the given name or uid. Raises an error
+    # if a user cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_user('joe')
+    #    Sys::Admin.get_user(501)
+    #
+    def self.get_user(uid)
+      if uid.is_a?(String)
+        pwd = PasswdStruct.new(getpwnam(uid))
+      else
+        pwd = PasswdStruct.new(getpwuid(uid))
+      end
+
+      if pwd.null?
+        raise Error, "no user found for: #{uid}"
+      end
+
+      user = User.new do |u|
+        u.name   = pwd[:pw_name]
+        u.passwd = pwd[:pw_passwd]
+        u.uid    = pwd[:pw_uid]
+        u.gid    = pwd[:pw_gid]
+        u.gecos  = pwd[:pw_gecos]
+        u.dir    = pwd[:pw_dir]
+        u.shell  = pwd[:pw_shell]
+      end
+
+      user
+    end
+
+    # Returns a Group object for the given name or uid. Raises an error
+    # if a group cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_group('admin')
+    #    Sys::Admin.get_group(101)
+    #
+    def self.get_group(gid)
+      if gid.is_a?(String)
+        grp = GroupStruct.new(getgrnam(gid))
+      else
+        grp = GroupStruct.new(getgrgid(gid))
+      end
+
+      if grp.null?
+        raise Error, "no group found for: #{gid}"
+      end
+
+      Group.new do |g|
+        g.name    = grp[:gr_name]
+        g.passwd  = grp[:gr_passwd]
+        g.gid     = grp[:gr_gid]
+        g.members = grp[:gr_mem].read_array_of_string
+      end
+    end
+
+    # Returns an array of User objects for each user on the system.
+    #
+    def self.users
+      users = []
+
+      begin
+        setpwent()
+
+        until (ptr = getpwent()).null?
+          pwd = PasswdStruct.new(ptr)
+          users << get_user_from_struct(pwd)
+        end
+      ensure
+        endpwent()
+      end
+
+      users
+    end
+
+    # Returns an array of Group objects for each user on the system.
+    #
+    def self.groups
+      groups = []
+
+      begin
+        setgrent()
+
+        until (ptr = getgrent()).null?
+          grp = GroupStruct.new(ptr)
+          groups << get_group_from_struct(grp)
+        end
+      ensure
+        endgrent()
+      end
+
+      groups
+    end
+
+    private
+
+    # Takes a GroupStruct and converts it to a Group object.
+    def self.get_group_from_struct(grp)
+      Group.new do |g|
+        g.name    = grp[:gr_name]
+        g.passwd  = grp[:gr_passwd]
+        g.gid     = grp[:gr_gid]
+        g.members = grp[:gr_mem].read_array_of_string
+      end
+    end
+
+    # Takes a UserStruct and converts it to a User object.
+    def self.get_user_from_struct(pwd)
+      user = User.new do |u|
+        u.name         = pwd[:pw_name]
+        u.passwd       = pwd[:pw_passwd]
+        u.uid          = pwd[:pw_uid]
+        u.gid          = pwd[:pw_gid]
+        u.gecos        = pwd[:pw_gecos]
+        u.dir          = pwd[:pw_dir]
+        u.shell        = pwd[:pw_shell]
+      end
+
+      user
+    end
+  end
+end