razorrisk-cassini-utilities-cassid 0.8.11

data/lib/razor_risk/cassini/utilities/cassid/service_controller.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'win32/service'
+require 'razor_risk/core/diagnostics/logger'
+
+# ##########################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassiD
+
+# ##########################################################
+# Service Controler
+
+class ServiceController
+    include ::RazorRisk::Core::Diagnostics::Logger
+    module Constants
+        ServiceOptions     = {
+            host:          nil,
+            service_type:  Win32::Service::WIN32_OWN_PROCESS,
+            start_type:    Win32::Service::AUTO_START,
+            error_control: Win32::Service::ERROR_NORMAL,
+            dependencies:  nil,
+        }
+        ServiceStopCommand = 'stop'
+    end
+
+    def initialize name
+        @name = check_parameter name, :name, type: ::String
+    end
+
+    def stoppable?
+        Win32::Service.status(
+            @name
+        ).controls_accepted.include?(
+            Constants::ServiceStopCommand
+        )
+    end
+
+    def exists?
+        Win32::Service.exists? @name
+    end
+
+    def register display_name, description, working_directory, script_path, config_path, ruby_path, *args
+
+        if exists?
+            log :warning, "Service '#{@name}' already exists"
+            return false
+        end
+
+        check_parameter display_name, :display_name, type: ::String
+        check_parameter description, :description, type: ::String
+        check_parameter working_directory, :working_directory, type: ::String
+        check_parameter script_path, :script_path, type: ::String
+        check_parameter config_path, :config_path, type: ::String
+        check_parameter args, :args, type: [ ::String ]
+
+        working_directory = File.expand_path(working_directory)
+        # TODO: Check if absolute, make relatve to working?
+
+        cmd = []
+        cmd << ruby_path
+        cmd << '-C' << working_directory
+        cmd << script_path
+        cmd << config_path
+        cmd << '--ruby-path' << ruby_path
+        cmd += args
+        cmd = cmd * ' '
+
+        options = Constants::ServiceOptions.merge(
+            service_name:     @name,
+            description:      description,
+            binary_path_name: cmd,
+            display_name:     display_name,
+        )
+        Win32::Service.create(options)
+    end
+
+    def unregister
+
+        unless exists?
+            log :warning, "Service '#{@name}' does not exist"
+            return false
+        end
+
+        Win32::Service.stop(@name) if stoppable?
+        Win32::Service.delete(@name)
+    end
+
+    def start
+        unless exists?
+            log :warning, "Service '#{@name}' does not exist"
+            return false
+        end
+
+        Win32::Service.start(@name)
+
+        while 'start pending' == Win32::Service.status(@name).current_state
+            sleep 1
+        end
+        sleep 1
+
+        'running' == Win32::Service.status(@name).current_state
+    end
+
+    def stop
+        unless exists?
+            log :warning, "Service '#{@name}' does not exist"
+            return false
+        end
+
+        if 'stopped' == Win32::Service.status(@name).current_state
+            log :warning, "Service '#{@name}' already stopped"
+            return false
+        end
+
+        unless  stoppable?
+            log :warning, "Service '#{@name}' cannot be stopped"
+            return false
+        end
+
+        Win32::Service.stop(@name)
+    end
+end
+
+
+# ##########################################################
+# modules
+
+end # module CassiD
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassid/validations.rb

@@ -0,0 +1,460 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassid/validations.rb
+#
+# Purpose:      Validations
+#
+# Created:      23rd February 2018
+# Updated:      2nd July 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+require 'razor_risk/cassini/utilities/cassid/constants'
+
+require 'razor_risk/core/filesystem/find_relative_file'
+
+require 'razor_risk/core/diagnostics/logger'
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassiD
+
+module Validations
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    module Internal_
+
+        def self.check_keys_of_ name, h, required, optional
+
+            trace ParamNames[ :name, :h, :required, :optional ], name, h, required, optional
+
+            unless ::Hash === h
+
+                log :warning, "The value of the '#{name}' node is not a hash"
+
+                return false
+            end
+
+            actual = h.keys
+
+            required.each do |rk|
+
+                unless actual.include? rk
+
+                    log :warning, "The key '#{name}' does not contain the required key '#{rk}'"
+
+                    return false
+                end
+            end
+
+            actual.each do |k|
+
+                unless (required + optional).include? k
+
+                    log :warning, "The key '#{name}' contains an unsupported key '#{k}'"
+
+                    return false
+                end
+            end
+
+            true
+        end
+
+        def self.check_microservices(h)
+
+            trace ParamNames[ :h ], h
+
+            case microservices = h['microservices']
+            when nil
+
+                log :warning, "no microservices specified"
+
+                return false
+            when ::Hash
+
+                ;
+            else
+
+                log :warning, "'microservices' element has wrong type #{microservices.class}, when it should be a #{::Hash}"
+
+                return false
+            end
+
+
+            case stock = microservices['stock']
+            when nil
+
+                log :warning, "no stock microservices specified"
+
+                return false
+            end
+
+            # now ensure that all services - stock and otherwise - are
+            # properly configured:
+
+            microservices.each do |category, services|
+
+                case services
+                when ::Hash
+
+                    ;
+                else
+
+                    log :warning, "microservices category '#{category}' must be a #{::Hash}"
+
+                    return false
+                end
+
+                services.each do |name, service|
+
+                    case service_path = service['service_path']
+                    when nil
+
+                        log :warning, "no 'service_path' specified for '#{service}'"
+
+                        return false
+                    when ::String
+
+                        ;
+                    else
+
+                        log :warning, "'service_path' element has wrong type #{service_path.class}, when it should be a #{::String}"
+
+                        return false
+                    end
+
+                    external_route  =   service['external_route']
+                    routes          =   service['routes']
+
+                    if external_route.nil?
+
+                        unless routes.nil?
+
+                            log :warning, "microservice '#{service}' has 'routes' but no 'external_route'"
+
+                            return false
+                        end
+                    else
+
+                        if routes.nil? || (::Array === routes && routes.empty?)
+
+                            log :warning, "microservice '#{service}' has 'external_route' but no 'routes'"
+
+                            return false
+                        else
+
+                            case external_route
+                            when ::String, ::Regexp
+
+                                ;
+                            else
+
+                                log :warning, "'external_route' element has wrong type #{external_route.class}, when it should be a #{::Regexp} or #{::String}"
+
+                                return false
+                            end
+
+                            case routes
+                            when ::Array
+
+                                unless routes.all? { |h| ::Hash === h }
+
+                                    log :warning, "Every item within a 'routes' array must be a #{::Hash}"
+
+                                    return false
+                                end
+                            else
+
+                                log :warning, "'routes' element has wrong type #{routes.class}, when it should be a #{::Array}"
+
+                                return false
+                            end
+                        end
+                    end
+                end
+            end
+
+            return true
+        end
+
+        def self.validate_file_relative_ path, config_path
+
+            trace ParamNames[ :path, :config_path ], path, config_path
+
+
+            # exists?
+
+            fe  =   Recls.stat path
+
+            return fe if fe
+
+
+            # relative to config file
+
+            yfe =   Recls.stat config_path
+            yd  =   yfe.directory_path
+
+            p2  =   Recls.combine_paths yd, path
+
+            fe2 =   Recls.stat p2
+
+            return fe2 if fe2
+
+
+            # relative to program file
+
+            pfe =   Recls.stat $0
+            pd  =   pfe.directory_path
+
+            p3  =   Recls.combine_paths pd, path
+
+            fe3 =   Recls.stat p3
+
+            return fe3 if fe3
+
+
+            # not found
+
+            nil
+        end
+    end # module Internal_
+
+    def valid_configuration? yaml
+
+        trace ParamNames[ :yaml ], yaml
+
+        unless ::Hash === yaml
+
+            log :warning, "object - '#{yaml}' (#{yaml.class}) - is not a #{::Hash}"
+
+            return false;
+        end
+
+        unless CONFIG_TOP_LEVEL_KEYS.sort == yaml.keys.sort
+
+            log :warning, "YAML does not contain exactly the top-level keys '#{CONFIG_TOP_LEVEL_KEYS}'"
+
+            return false;
+        end
+
+        # yaml['cassini']
+
+        return false unless Internal_.check_keys_of_('cassini', yaml['cassini'], CONFIG_cassini_KEYS_REQ, CONFIG_cassini_KEYS_OPT)
+
+        return false unless Internal_.check_microservices(yaml['cassini'])
+
+        return false unless valid_secret_server?(yaml['cassini']['secret_server'])
+
+
+        # yaml['control']
+
+        return false unless Internal_.check_keys_of_('control', yaml['control'], CONFIG_control_KEYS_REQ, CONFIG_control_KEYS_OPT)
+
+        # yaml['diagnostics']
+
+        return false unless Internal_.check_keys_of_('diagnostics', yaml['diagnostics'], CONFIG_diag_KEYS_REQ, CONFIG_diag_KEYS_OPT)
+
+        # yaml['razor']
+
+        return false unless Internal_.check_keys_of_('razor', yaml['razor'], CONFIG_razor_KEYS_REQ, CONFIG_razor_KEYS_OPT)
+
+        yaml
+    end
+
+    def valid_secret_server? ss
+
+        trace ParamNames[ :ss ], ss
+
+        case ss
+        when nil
+
+            return true
+        when ::Hash
+
+            host            =   ss['host']
+            port            =   ss['port']
+            secrets_path    =   ss['secrets_path']
+            service_path    =   ss['service_path']
+
+            if secrets_path.nil? != service_path.nil?
+
+                log :warning, "Must define both or neither of 'cassini/secret_server/secrets_path' and 'cassini/secret_server/service_path'"
+
+                return false
+            end
+
+            unless secrets_path
+
+                unless port
+
+                    log :warning, "Must specify 'cassini/secret_server/port' if not specifying 'cassini/secret_server/secrets_path' and 'cassini/secret_server/service_path'"
+
+                    return false
+                end
+            end
+
+            %w{ host secrets_path service_path }.each do |element_name|
+
+                case element = ss[element_name]
+                when nil
+
+                    ;
+                when ::String
+
+                    ;
+                else
+
+                    log :warning, "'cassini/secret_server/#{element_name}' must be an #{::String}, but is a #{element.class}"
+                end
+            end
+
+            case port
+            when nil
+
+                ;
+            when ::Integer
+
+                ;
+            else
+
+                log :warning, "'cassini/secret_server/port' must be an #{::Integer}, but is a #{port.class}"
+            end
+        else
+
+            log :warning, "'cassini/secret_server' must be a #{::Hash} or nil, but is a #{ss.class}"
+
+            return false
+        end
+
+        true
+    end
+
+    def validate_auth_mode m
+
+        trace ParamNames[ :m ], m
+
+        case m.to_s.downcase
+        when /auth(?:ori[sz]ation|)[-_]?only/
+
+            :authorisation_only
+        when 'basic'
+
+            :basic
+        when 'jwt'
+
+            :jwt
+        else
+
+            log :alert, 'currently only supported \'authorisation-only\' and \'basic\' modes'
+
+            nil
+        end
+    end
+
+    def validate_cassini_root_dir rd, *paths
+
+        trace ParamNames[ :rd, :paths ], rd, paths
+
+        ::RazorRisk::Core::Filesystem.find_relative_file rd, paths, canonicalise: true
+    end
+
+    def validate_tls t, config_path
+
+        trace ParamNames[ :t, :config_path ], t, config_path
+
+        t = nil if ::String === t && t.strip.empty?
+
+        case t
+        when nil
+
+            return []
+        when ::Hash
+
+            pc      =   t['cert']
+            pk      =   t['key']
+
+            return nil if pc.nil?
+            return nil if pk.nil?
+
+            cert    =   Internal_.validate_file_relative_ pc, config_path
+            key     =   Internal_.validate_file_relative_ pk, config_path
+
+            return nil unless cert
+            return nil unless key
+
+            return [ cert, key ]
+        when ::String
+
+            cert    =   Internal_.validate_file_relative_ t, config_path
+
+            return nil unless cert
+
+            pk      =   cert.path[0...(-cert.extension.size)] + '.key'
+
+            key     =   Recls.stat(pk)
+
+            return nil unless key
+
+            return [ cert, key ]
+        else
+
+            log :warning, "The value of 'tls' is neither a #{::Hash} nor a #{::String}"
+
+            return nil
+        end
+    end
+
+    def validate_clarite_config cc, *paths
+
+        trace ParamNames[ :cc, :paths ], cc, paths
+
+        cc  =   'clarite_config.xml' if (cc || '').empty?
+
+        ::RazorRisk::Core::Filesystem.find_relative_file cc, paths, canonicalise: true
+    end
+
+    def validate_executable rr, *paths
+
+        trace ParamNames[ :rr, :paths ], rr, paths
+
+        rr  =   'RazorRequest.exe' if (rr || '').empty?
+
+        ::RazorRisk::Core::Filesystem.find_relative_file rr, paths, canonicalise: true
+    end
+
+    def validate_service_path sp, *paths
+
+        trace ParamNames[ :sp, :paths ], sp, paths
+
+        ::RazorRisk::Core::Filesystem.find_relative_file sp, paths, canonicalise: true
+    end
+
+    def validate_relative_path p, *paths
+
+        trace ParamNames[ :p, :paths ], p, paths
+
+        ::RazorRisk::Core::Filesystem.find_relative_file p, paths, canonicalise: true
+    end
+
+end # module Validations
+end # module CassiD
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassid/version.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassid/version.rb
+#
+# Purpose:      Version for RazorRisk.Cassini.Utilities.CassiD library
+#
+# Created:      23rd February 2018
+# Updated:     24th January 2019
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+
+module CassiD
+
+    # Current version of the RazorRisk.Cassini.CassiD library
+    VERSION             =   '0.8.11'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.CassiD library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.CassiD library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.CassiD library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.CassiD library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's Initialisation Daemon"
+
+end # module CassiD
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassid.rb

@@ -0,0 +1,11 @@
+
+require 'razor_risk/cassini/utilities/cassid/constants'
+require 'razor_risk/cassini/utilities/cassid/configuration'
+require 'razor_risk/cassini/utilities/cassid/validations'
+require 'razor_risk/cassini/utilities/cassid/version'
+require 'razor_risk/cassini/utilities/cassid/main'
+require 'razor_risk/cassini/utilities/cassid/service_controller'
+
+# ############################## end of file ############################# #
+
+