win32-srv 1.0.0

data/lib/win32/windows/constants.rb

@@ -0,0 +1,143 @@
+module Windows
+  module ServiceConstants
+    SC_MANAGER_ALL_ACCESS         = 0xF003F
+    SC_MANAGER_CREATE_SERVICE     = 0x0002
+    SC_MANAGER_CONNECT            = 0x0001
+    SC_MANAGER_ENUMERATE_SERVICE  = 0x0004
+    SC_MANAGER_LOCK               = 0x0008
+    SC_MANAGER_MODIFY_BOOT_CONFIG = 0x0020
+    SC_MANAGER_QUERY_LOCK_STATUS  = 0x0010
+    SC_STATUS_PROCESS_INFO        = 0
+    SC_ENUM_PROCESS_INFO          = 0
+
+    # Service control action types
+    SC_ACTION_NONE        = 0
+    SC_ACTION_RESTART     = 1
+    SC_ACTION_REBOOT      = 2
+    SC_ACTION_RUN_COMMAND = 3
+
+    # Service access rights
+    SERVICE_ALL_ACCESS            = 0xF01FF
+    SERVICE_CHANGE_CONFIG         = 0x0002
+    SERVICE_ENUMERATE_DEPENDENTS  = 0x0008
+    SERVICE_INTERROGATE           = 0x0080
+    SERVICE_PAUSE_CONTINUE        = 0x0040
+    SERVICE_QUERY_CONFIG          = 0x0001
+    SERVICE_QUERY_STATUS          = 0x0004
+    SERVICE_START                 = 0x0010
+    SERVICE_STOP                  = 0x0020
+    SERVICE_USER_DEFINED_CONTROL  = 0x0100
+
+    # Service types
+    SERVICE_KERNEL_DRIVER       = 0x00000001
+    SERVICE_FILE_SYSTEM_DRIVER  = 0x00000002
+    SERVICE_ADAPTER             = 0x00000004
+    SERVICE_RECOGNIZER_DRIVER   = 0x00000008
+    SERVICE_WIN32_OWN_PROCESS   = 0x00000010
+    SERVICE_WIN32_SHARE_PROCESS = 0x00000020
+    SERVICE_WIN32               = 0x00000030
+    SERVICE_INTERACTIVE_PROCESS = 0x00000100
+    SERVICE_DRIVER              = 0x0000000B
+    SERVICE_TYPE_ALL            = 0x0000013F
+
+    # Error control
+    SERVICE_ERROR_IGNORE   = 0x00000000
+    SERVICE_ERROR_NORMAL   = 0x00000001
+    SERVICE_ERROR_SEVERE   = 0x00000002
+    SERVICE_ERROR_CRITICAL = 0x00000003
+
+    # Start types
+    SERVICE_BOOT_START   = 0x00000000
+    SERVICE_SYSTEM_START = 0x00000001
+    SERVICE_AUTO_START   = 0x00000002
+    SERVICE_DEMAND_START = 0x00000003
+    SERVICE_DISABLED     = 0x00000004
+
+    # Service control
+
+    SERVICE_CONTROL_STOP                   = 0x00000001
+    SERVICE_CONTROL_PAUSE                  = 0x00000002
+    SERVICE_CONTROL_CONTINUE               = 0x00000003
+    SERVICE_CONTROL_INTERROGATE            = 0x00000004
+    SERVICE_CONTROL_SHUTDOWN               = 0x00000005
+    SERVICE_CONTROL_PARAMCHANGE            = 0x00000006
+    SERVICE_CONTROL_NETBINDADD             = 0x00000007
+    SERVICE_CONTROL_NETBINDREMOVE          = 0x00000008
+    SERVICE_CONTROL_NETBINDENABLE          = 0x00000009
+    SERVICE_CONTROL_NETBINDDISABLE         = 0x0000000A
+    SERVICE_CONTROL_DEVICEEVENT            = 0x0000000B
+    SERVICE_CONTROL_HARDWAREPROFILECHANGE  = 0x0000000C
+    SERVICE_CONTROL_POWEREVENT             = 0x0000000D
+    SERVICE_CONTROL_SESSIONCHANGE          = 0x0000000E
+    SERVICE_CONTROL_PRESHUTDOWN            = 0x0000000F
+    SERVICE_CONTROL_TIMECHANGE             = 0x00000010
+    SERVICE_CONTROL_TRIGGEREVENT           = 0x00000020
+
+    # Service controls accepted
+
+    SERVICE_ACCEPT_STOP                    = 0x00000001
+    SERVICE_ACCEPT_PAUSE_CONTINUE          = 0x00000002
+    SERVICE_ACCEPT_SHUTDOWN                = 0x00000004
+    SERVICE_ACCEPT_PARAMCHANGE             = 0x00000008
+    SERVICE_ACCEPT_NETBINDCHANGE           = 0x00000010
+    SERVICE_ACCEPT_HARDWAREPROFILECHANGE   = 0x00000020
+    SERVICE_ACCEPT_POWEREVENT              = 0x00000040
+    SERVICE_ACCEPT_SESSIONCHANGE           = 0x00000080
+    SERVICE_ACCEPT_PRESHUTDOWN             = 0x00000100
+    SERVICE_ACCEPT_TIMECHANGE              = 0x00000200
+    SERVICE_ACCEPT_TRIGGEREVENT            = 0x00000400
+
+    # Service states
+    SERVICE_ACTIVE    = 0x00000001
+    SERVICE_INACTIVE  = 0x00000002
+    SERVICE_STATE_ALL = 0x00000003
+
+    # Service current states
+    SERVICE_STOPPED          = 0x00000001
+    SERVICE_START_PENDING    = 0x00000002
+    SERVICE_STOP_PENDING     = 0x00000003
+    SERVICE_RUNNING          = 0x00000004
+    SERVICE_CONTINUE_PENDING = 0x00000005
+    SERVICE_PAUSE_PENDING    = 0x00000006
+    SERVICE_PAUSED           = 0x00000007
+
+    # Info levels
+    SERVICE_CONFIG_DESCRIPTION              = 1
+    SERVICE_CONFIG_FAILURE_ACTIONS          = 2
+    SERVICE_CONFIG_DELAYED_AUTO_START_INFO  = 3
+    SERVICE_CONFIG_FAILURE_ACTIONS_FLAG     = 4
+    SERVICE_CONFIG_SERVICE_SID_INFO         = 5
+    SERVICE_CONFIG_REQUIRED_PRIVILEGES_INFO = 6
+    SERVICE_CONFIG_PRESHUTDOWN_INFO         = 7
+
+    # Configuration
+    SERVICE_NO_CHANGE = 0xffffffff
+
+    # Misc
+
+    WAIT_OBJECT_0 = 0
+    WAIT_TIMEOUT = 0x00000102
+    INFINITE = 0xFFFFFFFF
+
+    IDLE_CONTROL_CODE = 0
+
+    DELETE = 0x00010000
+    FORMAT_MESSAGE_FROM_SYSTEM    = 0x00001000
+    FORMAT_MESSAGE_IGNORE_INSERTS = 0x00000200
+
+    NO_ERROR = 0
+
+    SE_PRIVILEGE_ENABLED = 0x00000002
+    TOKEN_ADJUST_PRIVILEGES = 0x0020
+    TOKEN_QUERY = 0x0008
+
+    # Errors
+
+    ERROR_INSUFFICIENT_BUFFER = 122
+    ERROR_MORE_DATA = 234
+    ERROR_FILE_NOT_FOUND = 2
+    ERROR_RESOURCE_TYPE_NOT_FOUND = 1813
+    ERROR_RESOURCE_NAME_NOT_FOUND = 1814
+    WAIT_FAILED = 0xFFFFFFFF
+  end
+end

data/lib/win32/windows/functions.rb

@@ -0,0 +1,75 @@
+require "ffi" unless defined?(FFI)
+
+module Windows
+  module ServiceFunctions
+    extend FFI::Library
+
+    # Make FFI functions private
+    module FFI::Library
+      def attach_pfunc(*args)
+        attach_function(*args)
+        private args[0]
+      end
+    end
+
+    typedef :ulong, :dword
+    typedef :uintptr_t, :handle
+    typedef :pointer, :ptr
+    typedef :string, :str
+
+    ffi_convention :stdcall
+
+    ffi_lib :kernel32
+
+    attach_pfunc :CloseHandle, [:handle], :bool
+    attach_pfunc :CreateEvent, :CreateEventA, %i{ptr int int str}, :handle
+    attach_pfunc :CreateThread, %i{ptr size_t ptr ptr dword ptr}, :handle, blocking: true
+    attach_pfunc :EnterCriticalSection, [:ptr], :void
+    attach_pfunc :FormatMessage, :FormatMessageA, %i{ulong ptr ulong ulong str ulong ptr}, :ulong
+    attach_pfunc :GetCurrentProcess, [], :handle
+    attach_pfunc :InitializeCriticalSection, [:ptr], :void
+    attach_pfunc :LeaveCriticalSection, [:ptr], :void
+    attach_pfunc :SetEvent, [:handle], :bool
+    attach_pfunc :WaitForSingleObject, %i{handle dword}, :dword, blocking: true
+    attach_pfunc :WaitForMultipleObjects, %i{dword ptr int dword}, :dword
+
+    ffi_lib :advapi32
+
+    callback :handler_ex, %i{ulong ulong ptr ptr}, :void
+
+    attach_pfunc :AdjustTokenPrivileges, %i{handle int ptr dword ptr ptr}, :bool
+    attach_pfunc :CloseServiceHandle, [:handle], :bool
+
+    attach_pfunc :ChangeServiceConfig, :ChangeServiceConfigA,
+      %i{handle dword dword dword str str ptr ptr str str str},
+      :bool
+
+    attach_pfunc :ChangeServiceConfig2, :ChangeServiceConfig2A, %i{handle dword ptr}, :bool
+
+    attach_pfunc :CreateService, :CreateServiceA,
+      %i{handle string string dword dword dword dword
+       string string ptr pointer string string},
+       :handle
+
+    attach_pfunc :ControlService, %i{handle dword ptr}, :bool
+    attach_pfunc :DeleteService, [:handle], :bool
+
+    attach_pfunc :EnumServicesStatusEx, :EnumServicesStatusExA,
+      %i{handle int dword dword ptr dword ptr ptr ptr string},
+      :bool
+
+    attach_pfunc :GetServiceDisplayName, :GetServiceDisplayNameA, %i{handle string ptr ptr}, :bool
+    attach_pfunc :GetServiceKeyName, :GetServiceKeyNameA, %i{handle string ptr ptr}, :bool
+    attach_pfunc :LookupPrivilegeValue, :LookupPrivilegeValueA, %i{string string ptr}, :bool
+    attach_pfunc :OpenSCManager, :OpenSCManagerA, %i{ptr ptr dword}, :handle
+    attach_pfunc :OpenProcessToken, %i{handle dword ptr}, :bool
+    attach_pfunc :OpenService, :OpenServiceA, %i{handle string dword}, :handle
+    attach_pfunc :QueryServiceConfig, :QueryServiceConfigA, %i{handle ptr dword ptr}, :bool
+    attach_pfunc :QueryServiceConfig2, :QueryServiceConfig2A, %i{handle dword ptr dword ptr}, :bool
+    attach_pfunc :QueryServiceStatusEx, %i{handle int ptr dword ptr}, :bool
+    attach_pfunc :RegisterServiceCtrlHandlerEx, :RegisterServiceCtrlHandlerExA, %i{str handler_ex ptr}, :handle
+    attach_pfunc :SetServiceStatus, %i{handle ptr}, :bool
+    attach_pfunc :StartService, :StartServiceA, %i{handle dword ptr}, :bool
+    attach_pfunc :StartServiceCtrlDispatcher, :StartServiceCtrlDispatcherA, [:ptr], :bool, blocking: true
+  end
+end

data/lib/win32/windows/structs.rb

@@ -0,0 +1,121 @@
+require "ffi" unless defined?(FFI)
+
+module Windows
+  module ServiceStructs
+    extend FFI::Library
+
+    typedef :ulong, :dword
+
+    class SERVICE_STATUS < FFI::Struct
+      layout(
+        :dwServiceType, :ulong,
+        :dwCurrentState, :ulong,
+        :dwControlsAccepted, :ulong,
+        :dwWin32ExitCode, :ulong,
+        :dwServiceSpecificExitCode, :ulong,
+        :dwCheckPoint, :ulong,
+        :dwWaitHint, :ulong
+      )
+    end
+
+    class SERVICE_STATUS_PROCESS < FFI::Struct
+      layout(
+        :dwServiceType, :dword,
+        :dwCurrentState, :dword,
+        :dwControlsAccepted, :dword,
+        :dwWin32ExitCode, :dword,
+        :dwServiceSpecificExitCode, :dword,
+        :dwCheckPoint, :dword,
+        :dwWaitHint, :dword,
+        :dwProcessId, :dword,
+        :dwServiceFlags, :dword
+      )
+    end
+
+    class SERVICE_DESCRIPTION < FFI::Struct
+      layout(:lpDescription, :pointer)
+    end
+
+    class SERVICE_DELAYED_AUTO_START_INFO < FFI::Struct
+      layout(:fDelayedAutostart, :int) # BOOL
+
+      alias aset []=
+
+      # Intercept the accessor so that we can handle either true/false or 1/0.
+      # Since there is only one member, there's no need to check the key name.
+      #
+      def []=(key, value)
+        [0, false].include?(value) ? aset(key, 0) : aset(key, 1)
+      end
+    end
+
+    class QUERY_SERVICE_CONFIG < FFI::Struct
+      layout(
+        :dwServiceType, :dword,
+        :dwStartType, :dword,
+        :dwErrorControl, :dword,
+        :lpBinaryPathName, :pointer,
+        :lpLoadOrderGroup, :pointer,
+        :dwTagId, :dword,
+        :lpDependencies, :pointer,
+        :lpServiceStartName, :pointer,
+        :lpDisplayName, :pointer
+      )
+
+      def dependencies
+        length = self[:lpServiceStartName].address - self[:lpDependencies].address - 1
+        self[:lpDependencies].read_bytes(length).split(0.chr)
+      end
+    end
+
+    class ENUM_SERVICE_STATUS_PROCESS < FFI::Struct
+      layout(
+        :lpServiceName, :pointer,
+        :lpDisplayName, :pointer,
+        :ServiceStatusProcess, SERVICE_STATUS_PROCESS
+      )
+    end
+
+    class SC_ACTION < FFI::Struct
+      layout(:Type, :int, :Delay, :dword)
+    end
+
+    class SERVICE_FAILURE_ACTIONS < FFI::Struct
+      layout(
+        :dwResetPeriod, :dword,
+        :lpRebootMsg, :pointer,
+        :lpCommand, :pointer,
+        :cActions, :dword,
+        :lpsaActions, :pointer # Array of SC_ACTION structs
+      )
+    end
+
+    class SERVICE_TABLE_ENTRY < FFI::Struct
+      layout(
+        :lpServiceName, :pointer,
+        :lpServiceProc, :pointer
+      )
+    end
+
+    class LUID < FFI::Struct
+      layout(
+        :LowPart, :ulong,
+        :HighPart, :long
+      )
+    end
+
+    class LUID_AND_ATTRIBUTES < FFI::Struct
+      layout(
+        :Luid, LUID,
+        :Attributes, :ulong
+      )
+    end
+
+    class TOKEN_PRIVILEGES < FFI::Struct
+      layout(
+        :PrivilegeCount, :dword,
+        :Privileges, [LUID_AND_ATTRIBUTES, 1]
+      )
+    end
+  end
+end

data/lib/win32/windows/version.rb

@@ -0,0 +1,6 @@
+module Win32
+  class Service
+    VERSION = "1.0.0".freeze
+    MAJOR, MINOR, TINY = VERSION.split(".")
+  end
+end

data/lib/win32-daemon.rb

@@ -0,0 +1 @@
+require_relative "win32/daemon"

data/lib/win32-service.rb

@@ -0,0 +1 @@
+require_relative "win32/service"

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: win32-srv
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gernot Gradwohl
+bindir: bin
+cert_chain: []
+date: 2025-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-win32-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: win32-security
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      The win32-srv library provides a Ruby interface to services on
+      MS Windows. You can create new services, or control, configure and
+      inspect existing services.
+
+      In addition, you can create a pure Ruby service by using the Daemon
+      class that is included as part of the library.
+email: grnt.grdwhl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/win32-daemon.rb
+- lib/win32-service.rb
+- lib/win32/daemon.rb
+- lib/win32/service.rb
+- lib/win32/windows/constants.rb
+- lib/win32/windows/functions.rb
+- lib/win32/windows/structs.rb
+- lib/win32/windows/version.rb
+homepage: https://github.com/choallin/win32-service
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: An interface for MS Windows services
+test_files: []