cfn-guardian 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee40f497dbc0a21900bc4c3ae1ddd6200a4b28cd030991b6b573ace4f044b0b
-  data.tar.gz: 947d9ececf862afee6fc2bb36cb09b9713950815305e98b162b24315da5f5097
+  metadata.gz: 5c46c2a4b2730c333ff1e85810cd65f9fb8df414f4109e7c2959c4c9bfda3b43
+  data.tar.gz: f47115047e95163b834b80577dce76b81903c98611178bfd3348183f7bc599c1
 SHA512:
-  metadata.gz: 7bf6e4c76646d28995558d81d5c37b6d08c9259fceda8a4143e33be785df0dbc70535096a4cd3e7a607806b2cffd13c653fc958fca20cae395c70ed34a71a5ec
-  data.tar.gz: 4bbe13a6fb4b1156543f022fba2bd22de240d0e89eed02a91b0582346f430c26cd56cac161c664bd614902be29d21474b78d325b463b45da90e9112496a8a478
+  metadata.gz: 56b5fff929781714f5b006c2589145e9780cdd65ceb1b993513f0a8d52581eb2e5f4898b795a983718c81a477c57ee906466a3f93d4778633b18bb0c413facb2
+  data.tar.gz: 636bd4eed99c7a26febce34dc77ad581900dd23072b2f5770e6ac45b1f5030539b8b9d7c43d691c806bec9b1fa5ed3c0e619dd9652e31d74ea1c898234a7c51b

data/docs/custom_checks/websocket.md

@@ -0,0 +1,16 @@
+# Websocket
+
+## WebsocketCheck
+
+Cloudwatch NameSpace: `WebSocketCheck`
+
+```yaml
+Resources:
+  WebSocket:
+  # Array of resources defining the http endpoint with the Id: key
+  - Id: wss://example.com/websocket
+    # message to send to websocket
+    Message: {'ping-test'}
+    # expected suffix response from websocket eg: response message starts with '{"id":"ping-test","message":...,
+    Expected_Response: '{"id":"ping-test","message":{...'
+```

data/docs/overview.md

@@ -15,6 +15,7 @@
     8. [TLS](custom_checks/tls.md)
     9. [Azure File Check](custom_checks/azure_file_check.md)
     10. [ECS Container Instance Check](custom_checks/ecs_container_instance_check.md)
+    11. [Web Socket](custom_checks/websocket.md)
 5. [Event Subscriptions](event_subscriptions.md)
 6. [Notifiers](notifiers.md)
 7. [Maintenance Mode](maintenance_mode.md)

data/lib/cfnguardian/compile.rb

@@ -24,6 +24,7 @@ require 'cfnguardian/resources/elastic_file_system'
 require 'cfnguardian/resources/elasticache_replication_group'
 require 'cfnguardian/resources/elastic_loadbalancer'
 require 'cfnguardian/resources/http'
+require 'cfnguardian/resources/websocket'
 require 'cfnguardian/resources/internal_http'
 require 'cfnguardian/resources/port'
 require 'cfnguardian/resources/internal_port'

data/lib/cfnguardian/models/alarm.rb

@@ -322,6 +322,18 @@ module CfnGuardian
       end
     end
 
+    class WebSocketAlarm < BaseAlarm
+      def initialize(resource)
+        super(resource)
+        @group = 'WebSocket'
+        @namespace = 'WebSocketCheck'
+        @dimensions = { Endpoint: resource['Id'] }
+        @comparison_operator = 'LessThanThreshold'
+        @threshold = 1
+        @evaluation_periods = 2
+      end
+    end
+
     class InternalHttpAlarm < HttpAlarm
       def initialize(resource)
         super(resource)

data/lib/cfnguardian/models/check.rb

@@ -15,7 +15,8 @@ module CfnGuardian
         :subnets, 
         :vpc,
         :memory,
-        :timeout
+        :timeout,
+        :branch
         
       def initialize(resource)
         @type = 'Check'
@@ -30,6 +31,7 @@ module CfnGuardian
         @vpc = nil
         @memory = 128
         @timeout = 120
+        @branch = "master"
       end
     end
     
@@ -44,6 +46,18 @@ module CfnGuardian
         @runtime = 'python3.7'
       end
     end
+    class WebSocketCheck < BaseCheck      
+      def initialize(resource)
+        super(resource)
+        @group = 'WebSocket'
+        @name = 'WebSocketCheck'
+        @package = 'websocket-check'
+        @handler = 'handler.websocket_check'
+        @version = '1f242f6741f6b561f22f6761a1287e7a0b69d06f'
+        @runtime = 'python3.7'
+        @branch = 'main'
+      end
+    end
     
     class InternalHttpCheck < HttpCheck
       def initialize(resource)

data/lib/cfnguardian/models/event.rb

@@ -30,7 +30,7 @@ module CfnGuardian
         @ssm_parameters = []
       end      
     end
-    
+
     class HttpEvent < BaseEvent
       
       attr_accessor :endpoint,
@@ -72,6 +72,37 @@ module CfnGuardian
         return payload.to_json
       end
     end
+
+    class WebSocketEvent < BaseEvent
+      
+      attr_accessor :endpoint,
+        :message,
+        :expected_response,
+        :timeout,
+        :payload
+      
+      def initialize(resource)
+        super(resource)
+        @group = 'WebSocket'
+        @name = 'WebSocketEvent'
+        @target = 'WebSocketCheckFunction'
+        @endpoint = resource['Id']
+        @message = resource.fetch('Message',nil)
+        @expected_response = resource.fetch('Expected_Response',nil)
+        @timeout = resource.fetch('Timeout',50)
+        @payload = resource.fetch('Payload',nil)
+      end
+      
+      def payload
+        payload = {
+          'ENDPOINT' => @endpoint,
+          'MESSAGE' => @message,
+          'EXPECTED_RESPONSE' => @expected_response
+        }
+        payload['PAYLOAD'] = @payload unless @payload.nil?
+        return payload.to_json
+      end
+    end
     
     class InternalHttpEvent < HttpEvent      
       def initialize(resource,environment)

data/lib/cfnguardian/resources/autoscaling_group.rb

@@ -18,5 +18,15 @@ module CfnGuardian::Resource
       @alarms.push(alarm)
     end
     
+    def default_event_subscriptions()
+      event_subscription = CfnGuardian::Models::AutoScalingGroupEventSubscription.new(@resource)
+      event_subscription.name = 'LaunchUnsuccessful'
+      event_subscription.detail_type = 'EC2 Instance Launch Unsuccessful'
+      event_subscription.detail = {
+        'instance-id' => [@resource['Id']],
+        'state' => ['terminated']
+      }
+      @event_subscriptions.push(event_subscription)
+    end
   end
 end

data/lib/cfnguardian/resources/websocket.rb

@@ -0,0 +1,32 @@
+require 'digest/md5'
+
+module CfnGuardian::Resource
+  class WebSocket < Base
+    
+    def default_alarms    
+      alarm = CfnGuardian::Models::WebSocketAlarm.new(@resource)
+      alarm.name = 'EndpointAvailable'
+      alarm.metric_name = 'Available'
+      @alarms.push(alarm)
+      
+      alarm = CfnGuardian::Models::WebSocketAlarm.new(@resource)
+      alarm.name = 'EndpointTimeTaken'
+      alarm.comparison_operator = 'GreaterThanThreshold'
+      alarm.metric_name = 'TimeTaken'
+      alarm.statistic = 'Minimum'
+      alarm.threshold = 5000
+      alarm.period = 300
+      alarm.evaluation_periods = 1
+      @alarms.push(alarm)
+    end
+    
+    def default_events()
+      @events.push(CfnGuardian::Models::WebSocketEvent.new(@resource))
+    end
+    
+    def default_checks()
+      @checks.push(CfnGuardian::Models::WebSocketCheck.new(@resource))
+    end
+    
+  end
+end

data/lib/cfnguardian/stacks/main.rb

@@ -136,7 +136,7 @@ module CfnGuardian
           Lambda_Function("#{check.name}Function#{check.environment}") do
             Code({ 
               S3Bucket: FnSub("base2.guardian.lambda.checks.${AWS::Region}"), 
-              S3Key: "#{check.package}/master/#{check.version}.zip"
+              S3Key: "#{check.package}/#{check.branch}/#{check.version}.zip"
             })
             Handler check.handler
             MemorySize check.memory

data/lib/cfnguardian/version.rb

@@ -1,4 +1,4 @@
 module CfnGuardian
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
   CHANGE_SET_VERSION = VERSION.gsub('.', '-').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-guardian
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -262,6 +262,7 @@ files:
 - docs/custom_checks/sftp.md
 - docs/custom_checks/sql.md
 - docs/custom_checks/tls.md
+- docs/custom_checks/websocket.md
 - docs/custom_metrics.md
 - docs/event_subscriptions.md
 - docs/maintenance_mode.md
@@ -331,6 +332,7 @@ files:
 - lib/cfnguardian/resources/tls.rb
 - lib/cfnguardian/resources/vpn_connection.rb
 - lib/cfnguardian/resources/vpn_tunnel.rb
+- lib/cfnguardian/resources/websocket.rb
 - lib/cfnguardian/s3.rb
 - lib/cfnguardian/stacks/main.rb
 - lib/cfnguardian/stacks/resources.rb