aws-sdk-v1 1.52.0

data/lib/aws/sns/message.rb

@@ -0,0 +1,204 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'base64'
+require 'json'
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'uri'
+
+Dir.glob("#{File.dirname __FILE__}/originators/*.rb").each { |rb| require rb }
+
+module AWS
+  class SNS
+    class MessageWasNotAuthenticError < StandardError
+    end
+
+    # Represents a single SNS message.
+    #
+    # See also http://docs.amazonwebservices.com/sns/latest/gsg/json-formats.html
+    #
+    # = Originators
+    # Originators are sources of SNS messages.  {FromAutoScaling} is one.  {Message}
+    # can be extended by originators if their #applicable? method returns true when
+    # passed the raw message.
+    # Originator modules must implement `applicable? sns` module function.
+    # If an originator is applicable, it should set the `@origin` accessor to denote 
+    # itself.
+    class Message
+      SIGNABLE_KEYS = [
+        'Message',
+        'MessageId',
+        'Subject',
+        'SubscribeURL',
+        'Timestamp',
+        'Token',
+        'TopicArn',
+        'Type',
+      ].freeze
+
+      attr_reader :raw
+      attr_accessor :origin
+
+      # @return {Message} Constructs a new {Message} from the raw SNS, sets origin
+      def initialize sns
+        if sns.is_a? String
+          @raw = parse_from sns
+        else
+          @raw = sns
+        end
+        @origin = :sns
+        self.extend FromAutoScaling if FromAutoScaling.applicable? @raw
+      end
+
+      # @param [String] key Indexer into raw SNS JSON message.
+      # @return [String] the value of the SNS' field
+      def [] key
+        @raw[key]
+      end
+
+      # @return [Boolean] true when the {Message} is authentic:
+      #   SigningCert is hosted at amazonaws.com, on https
+      #   correctly cryptographically signed by sender
+      #   nothing went wrong during authenticating the {Message}
+      #
+      # See http://docs.amazonwebservices.com/sns/latest/gsg/SendMessageToHttp.verify.signature.html
+      def authentic?
+        begin
+          decoded_from_base64 = decode signature
+          public_key = get_public_key_from signing_cert_url
+          public_key.verify OpenSSL::Digest::SHA1.new, decoded_from_base64, canonical_string
+        rescue MessageWasNotAuthenticError
+          false
+        end
+      end
+
+      # @return[Symbol] the message type
+      def type
+        case when @raw['Type'] =~ /SubscriptionConfirmation/i
+          then :SubscriptionConfirmation
+        when @raw['Type'] =~ /Notification/i
+          then :Notification
+        when @raw['Type'] =~ /UnsubscribeConfirmation/i
+          then :UnsubscribeConfirmation
+        else
+          :unknown
+        end
+      end
+
+      def message_id
+        @raw['MessageId']
+      end
+
+      def topic_arn
+        @raw['TopicArn']
+      end
+
+      def subject
+        @raw['Subject']
+      end
+
+      def message
+        @raw['Message']
+      end
+
+      def timestamp
+        @raw['Timestamp']
+      end
+
+      def signature
+        @raw['Signature']
+      end
+
+      def signature_version
+        @raw['SignatureVersion']
+      end
+
+      def signing_cert_url
+        @raw['SigningCertURL']
+      end
+
+      def subscribe_url
+        @raw['SubscribeURL']
+      end
+
+      def token
+        @raw['Token']
+      end
+
+      def unsubscribe_url
+        @raw['UnsubscribeURL']
+      end
+
+      def parse_from json
+        JSON.parse json
+      end
+
+      protected
+      def decode raw
+        Base64.decode64 raw
+      end
+
+      def get_public_key_from(x509_pem_url)
+        cert_pem = download x509_pem_url
+        x509 = OpenSSL::X509::Certificate.new(cert_pem)
+        OpenSSL::PKey::RSA.new(x509.public_key)
+      end
+
+      def canonical_string
+        text = ''
+        SIGNABLE_KEYS.each do |key|
+          value = @raw[key]
+          next if value.nil? or value.empty?
+          text << key << "\n"
+          text << value << "\n"
+        end
+        text
+      end
+
+      def download url
+        uri = URI.parse(url)
+        unless
+          uri.scheme == 'https' &&
+          uri.host.match(/^sns\.[a-zA-Z0-9\-]{3,}\.amazonaws\.com(\.cn)?$/) &&
+          File.extname(uri.path) == '.pem'
+        then
+          msg = "cert is not hosted at AWS URL (https): #{url}"
+          raise MessageWasNotAuthenticError, msg
+        end
+        tries = 0
+        begin
+          resp = https_get(url)
+          resp.body
+        rescue => error
+          tries += 1
+          retry if tries < 3
+          raise error
+        end
+      end
+
+      def https_get(url)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.start
+        resp = http.request(Net::HTTP::Get.new(uri.request_uri))
+        http.finish
+        resp
+      end
+
+    end
+  end
+end

data/lib/aws/sns/originators/from_auto_scaling.rb

@@ -0,0 +1,68 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SNS
+
+    # A module to enrich {Message} based on it originating from AutoScaling,
+    # which have a particular subject and message payload.
+    # Parses such messages into a more rich representation.
+    module FromAutoScaling
+      def self.extended base
+        base.origin = :autoscaling
+      end
+
+      # @return [Boolean] true when the SNS originates from auto-scaling
+      def applicable? sns
+        sns['Subject'] =~ /.*autoscaling:.*/i
+      end
+
+      module_function :applicable?
+
+      def body
+        return @body if defined? @body
+        @body = self.parse_from self.raw['Message']
+      end
+
+      # @return [Symbol] the auto-scaling event name
+      def event
+        return @event if defined? @event
+        e = body['Event']
+        @event = case
+          when e =~ /EC2_INSTANCE_TERMINATE/ then :ec2_instance_terminate
+          when e =~ /EC2_INSTANCE_TERMINATE_ERROR/ then :ec2_instance_terminate_error
+          when e =~ /EC2_INSTANCE_LAUNCH/ then :ec2_instance_launch
+          when e =~ /EC2_INSTANCE_LAUNCH_ERROR/ then :ec2_instance_launch_error
+          when e =~ /TEST_NOTIFICATION/ then :test_notification
+          else :unknown
+        end
+      end
+
+      # @return [String] the auto-scaling group name
+      def group_name
+        body['AutoScalingGroupName']
+      end
+
+      def status_code
+        body['StatusCode']
+      end
+
+      # @return [String] the instance-ID that is the subject of this event
+      def instance_id
+        body['EC2InstanceId']
+      end
+
+      # TODO: Further methods to fully expose what AS-SNS' carry as payload.
+    end
+  end
+end

data/lib/aws/sns/policy.rb

@@ -0,0 +1,47 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SNS
+
+    # (see Core::Policy)
+    class Policy < Core::Policy
+
+      class Statement < Core::Policy::Statement
+
+        ACTION_MAPPING = {
+          :add_permission => 'sns:AddPermission',
+          :delete_topic => 'sns:DeleteTopic',
+          :get_topic_attributes => 'sns:GetTopicAttributes',
+          :list_subscriptions_by_topic => 'sns:ListSubscriptionsByTopic',
+          :publish => 'sns:Publish',
+          :receive => 'sns:Receive',
+          :remove_permission => 'sns:RemovePermission',
+          :set_topic_attributes => 'sns:SetTopicAttributes',
+          :subscribe => 'sns:Subscribe',
+        }
+
+        protected
+        def resource_arn resource
+          case resource
+          when Topic then resource.arn
+          #when Subscription then resource.arn
+          else super(resource)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws/sns/subscription.rb

@@ -0,0 +1,165 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class SNS
+
+    # Represents a subscription of a single endpoint to an SNS topic.
+    # To create a subscription, use the {Topic#subscribe} method.
+    # Depending on the endpoint type, you may also need to use
+    # {Topic#confirm_subscription}.
+    class Subscription
+
+      include Core::Model
+      include HasDeliveryPolicy
+
+      # @api private
+      def initialize(arn, opts = {})
+        @arn = arn
+        @topic_arn = opts[:topic_arn]
+        @endpoint = opts[:endpoint]
+        @protocol = opts[:protocol]
+        @owner_id = opts[:owner_id]
+        super
+      end
+
+      # @return [String] The ARN of the subscription.
+      attr_reader :arn
+
+      # @return [String] The endpoint.  This can be an HTTP or HTTPS
+      # URL, an e-mail address, or a queue ARN.
+      attr_reader :endpoint
+
+      # @return [String] The protocol.  Possible values:
+      #
+      #  * `:http`
+      #  * `:https`
+      #  * `:email`
+      #  * `:email_json`
+      #  * `:sqs`
+      attr_reader :protocol
+
+      # @return [String] The AWS account ID of the subscription owner.
+      def owner_id
+        @owner_id ||= get_attributes['Owner']
+      end
+
+      # @return [String]
+      def topic_arn
+        @topic_arn ||= get_attributes['TopicArn']
+      end
+
+      # @return [Topic]
+      def topic
+        Topic.new(topic_arn, :config => config)
+      end
+
+      # Deletes this subscription.
+      # @return [nil]
+      def unsubscribe
+        client.unsubscribe(:subscription_arn => arn)
+        nil
+      end
+
+      # @return [Boolean] Returns true if the subscription confirmation
+      #   request was authenticated.
+      def confirmation_authenticated?
+
+        return true if @authenticated
+
+        if authenticated = get_attributes['ConfirmationWasAuthenticated']
+          @authenticated = true
+        else
+          false
+        end
+
+      end
+
+      # You can get the parsed JSON hash from {#delivery_policy}.
+      # @return [nil,String] Returns the delivery policy JSON string.
+      def delivery_policy_json
+        get_attributes['DeliveryPolicy']
+      end
+
+      # You can get the parsed JSON hash from {#effective_delivery_policy}.
+      # @return [nil,String] Returns the effective delivery policy JSON string.
+      def effective_delivery_policy_json
+        get_attributes['EffectiveDeliveryPolicy']
+      end
+
+      # @return [Boolean] Returns true if the subscriptions has raw message delivery enabled.
+      def raw_message_delivery
+        raw_value = get_attributes['RawMessageDelivery']
+        raw_value.downcase == 'true'
+      end
+
+      # @param [Boolean] raw_delivery Whether to enable or disable raw message delivery.
+      def raw_message_delivery= raw_delivery
+        value = if raw_delivery
+          'true'
+        else
+          'false'
+        end
+        update_subscription_attribute('RawMessageDelivery', value)
+      end
+
+      # @note This method requests the entire list of subscriptions
+      #   for the topic (if known) or the account (if the topic is not
+      #   known).  It can be expensive if the number of subscriptions
+      #   is high.
+      #
+      # @return [Boolean] Returns true if the subscription exists.
+      def exists?
+        begin
+          get_attributes
+          true
+        rescue Errors::NotFound, Errors::InvalidParameter
+          false
+        end
+      end
+
+      # @api private
+      def inspect
+        "<#{self.class} arn:#{arn}>"
+      end
+
+      # @return [Boolean] Returns true if the subscriptions have the same
+      #   resource ARN.
+      def eql? other
+        other.kind_of?(Subscription) and other.arn == arn
+      end
+      alias_method :==, :eql?
+
+      protected
+      def update_subscription_attribute name, value
+        client_opts = {}
+        client_opts[:subscription_arn] = arn
+        client_opts[:attribute_name] = name
+        client_opts[:attribute_value] = value
+        client.set_subscription_attributes(client_opts)
+      end
+
+      protected
+      def update_delivery_policy policy_json
+        update_subscription_attribute('DeliveryPolicy', policy_json)
+      end
+
+      protected
+      def get_attributes
+        client.get_subscription_attributes(:subscription_arn => arn).attributes
+      end
+
+    end
+
+  end
+end