sys-admin 1.8.0-universal-mingw32

data/examples/example_groups.rb

@@ -0,0 +1,27 @@
+###########################################################################
+# groups.rb
+#
+# Sample script to demonstrate some of the various group methods.  Alter
+# as you see fit.
+###########################################################################
+require "pp"
+require "sys/admin"
+include Sys
+
+if File::ALT_SEPARATOR
+  pp Admin.get_group("guests")
+  pp Admin.get_group(513)
+else
+  pp Admin.get_group("admin")
+  pp Admin.get_group(7)
+end
+
+sleep 3
+
+Admin.groups.each{ |g|
+   pp g
+   puts
+}
+
+# This should raise an error
+Admin.get_group("fofofofof")

data/examples/example_users.rb

@@ -0,0 +1,41 @@
+###########################################################################
+# users.rb
+#
+# Sample script to demonstrate some of the various user methods.  Alter
+# as you see fit.
+###########################################################################
+require "pp"
+require "sys/admin"
+include Sys
+
+=begin
+user = User.new do |u|
+  u.name              = "Foo"
+  u.description       = "Test account"
+  u.password          = "changeme"
+  #u.lockout           = false
+  u.disabled          = true
+  #u.password_required = true
+end
+
+Admin.delete_user(u.name) rescue nil
+Admin.add_user(user)
+
+pp Admin.get_user("Foo")
+
+Admin.delete_user("Foo")
+=end
+
+user = Admin.get_login
+
+puts "User: #{user}"
+
+sleep 3
+
+Admin.users.each{ |u|
+  pp u
+  puts
+}
+
+pp Admin.get_user(user)
+pp Admin.get_user(501)

data/lib/bsd/sys/admin.rb

@@ -0,0 +1,262 @@
+require 'sys/admin/custom'
+require 'sys/admin/common'
+require 'rbconfig'
+
+# The BSD specific code.
+
+module Sys
+  class Admin
+    # :no-doc:
+    BUF_MAX = 65536 # Max buffer for retry
+    private_constant :BUF_MAX
+
+    # 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, :int], :int
+    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+
+    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_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
+      fields = [
+        :pw_name, :string,
+        :pw_passwd, :string,
+        :pw_uid, :uid_t,
+        :pw_gid, :gid_t,
+        :pw_change, :time_t,
+        :pw_class, :string,
+        :pw_gecos, :string,
+        :pw_dir, :string,
+        :pw_shell, :string,
+        :pw_expire, :time_t
+      ]
+
+      if RbConfig::CONFIG['host_os'] =~ /freebsd/i
+        fields.push(:pw_fields, :int)
+      end
+
+      layout(*fields)
+    end
+
+    private_constant :PasswdStruct
+
+    # 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
+
+    private_constant :GroupStruct
+
+    # I'm blending the timeval struct in directly here
+    class LastlogStruct < FFI::Struct
+      layout(
+        :ll_time, :int32,
+        :ll_line, [:char, 32],
+        :ll_host, [:char, 256]
+      )
+    end
+
+    private_constant :LastlogStruct
+
+    # Returns the login for the current process.
+    #
+    def self.get_login
+      buf = FFI::MemoryPointer.new(:char, 256)
+
+      if getlogin_r(buf, buf.size) != 0
+        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)
+      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      temp = PasswdStruct.new
+
+      if uid.is_a?(String)
+        if getpwnam_r(uid, temp, buf, buf.size, pbuf) != 0
+          raise Error, "getpwnam_r function failed: " + strerror(FFI.errno)
+        end
+      else
+        if getpwuid_r(uid, temp, buf, buf.size, pbuf) != 0
+          raise Error, "getpwuid_r function failed: " + strerror(FFI.errno)
+        end
+      end
+
+      ptr = pbuf.read_pointer
+
+      if ptr.null?
+        raise Error, "no user found for #{uid}"
+      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)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
+      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      temp = GroupStruct.new
+
+      begin
+        if gid.is_a?(String)
+          val = getgrnam_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrnam_r'
+        else
+          val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrgid_r'
+        end
+        raise SystemCallError.new(fun, val) if val != 0
+      rescue Errno::ERANGE
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
+      end
+
+      ptr = pbuf.read_pointer
+
+      if ptr.null?
+        raise Error, "no group found for '#{gid}'"
+      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 = []
+
+      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
+
+    # 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
+
+    private_class_method :get_group_from_struct
+
+    # 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.change       = Time.at(pwd[:pw_change])
+        u.access_class = pwd[:pw_class]
+        u.gecos        = pwd[:pw_gecos]
+        u.dir          = pwd[:pw_dir]
+        u.shell        = pwd[:pw_shell]
+        u.expire       = Time.at(pwd[:pw_expire])
+      end
+
+      log = get_lastlog_info(user.uid)
+
+      if log
+        user.login_time = Time.at(log[:ll_time])
+        user.login_device = log[:ll_line].to_s
+        user.login_host = log[:ll_host].to_s
+      end
+
+      user
+    end
+
+    private_class_method :get_user_from_struct
+
+    # Get lastlog information for the given user.
+    def self.get_lastlog_info(uid)
+      logfile = '/var/log/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
+
+    private_class_method :get_lastlog_info
+  end
+end

data/lib/darwin/sys/admin.rb

@@ -0,0 +1,244 @@
+require 'sys/admin/custom'
+require 'sys/admin/common'
+
+# The Darwin specific code.
+
+module Sys
+  class Admin
+    # :no-doc:
+    BUF_MAX = 65536 # Max buf size for retry.
+    private_constant :BUF_MAX
+
+    attach_function :getlogin_r, [:pointer, :int], :int
+    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getlastlogx, [:long, :pointer], :pointer
+
+    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r
+    private_class_method :getgrnam_r, :getgrgid_r, :getlastlogx
+
+    # 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_change, :ulong,
+        :pw_class, :string,
+        :pw_gecos, :string,
+        :pw_dir, :string,
+        :pw_shell, :string,
+        :pw_expire, :ulong
+      )
+    end
+
+    private_constant :PasswdStruct
+
+    # 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
+
+    private_constant :GroupStruct
+
+    # I'm blending the timeval struct in directly here
+    class LastlogxStruct < FFI::Struct
+      layout(
+        :tv_sec, :long,
+        :tv_usec, :long,
+        :ll_line, [:char, 32],
+        :ll_host, [:char, 256]
+      )
+    end
+
+    private_constant :LastlogxStruct
+
+    # Returns the login for the current process.
+    #
+    def self.get_login
+      buf = FFI::MemoryPointer.new(:char, 256)
+
+      if getlogin_r(buf, buf.size) != 0
+        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)
+      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      temp = PasswdStruct.new
+
+      if uid.is_a?(String)
+        if getpwnam_r(uid, temp, buf, buf.size, pbuf) != 0
+          raise Error, "getpwnam_r function failed: " + strerror(FFI.errno)
+        end
+      else
+        if getpwuid_r(uid, temp, buf, buf.size, pbuf) != 0
+          raise Error, "getpwuid_r function failed: " + strerror(FFI.errno)
+        end
+      end
+
+      ptr = pbuf.read_pointer
+
+      if ptr.null?
+        raise Error, "no user found for #{uid}"
+      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)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
+      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      temp = GroupStruct.new
+
+      begin
+        if gid.is_a?(String)
+          val = getgrnam_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrnam_r'
+        else
+          val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrgid_r'
+        end
+        raise SystemCallError.new(fun, val) if val != 0
+      rescue Errno::ERANGE
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
+      end
+
+      ptr = pbuf.read_pointer
+
+      if ptr.null?
+        raise Error, "no group found for '#{gid}'"
+      end
+
+      grp = GroupStruct.new(ptr)
+      get_group_from_struct(grp)
+    end
+
+    # Returns an array of User objects for each user on the system.
+    #
+    #--
+    # This method is somewhat slow on OSX because of the call to get
+    # lastlog information. I'm not sure why.
+    #
+    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
+
+    # 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
+
+    private_class_method :get_group_from_struct
+
+    # 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.change       = Time.at(pwd[:pw_change])
+        u.access_class = pwd[:pw_class]
+        u.gecos        = pwd[:pw_gecos]
+        u.dir          = pwd[:pw_dir]
+        u.shell        = pwd[:pw_shell]
+        u.expire       = Time.at(pwd[:pw_expire])
+      end
+
+      log = get_lastlog_info(user.uid)
+
+      if log
+        user.login_time = Time.at(log[:tv_sec])
+        user.login_device = log[:ll_line].to_s
+        user.login_host = log[:ll_host].to_s
+      end
+
+      user
+    end
+
+    private_class_method :get_user_from_struct
+
+    # Gets lastlog information for the given user.
+    def self.get_lastlog_info(uid)
+      lastlog = LastlogxStruct.new
+
+      # We don't check for failure here because most will fail due to
+      # lack of permissions and/or simple lack of information.
+      ptr = getlastlogx(uid, lastlog)
+
+      ptr.null? ? nil : lastlog
+    end
+
+    private_class_method :get_lastlog_info
+  end
+end