ssrfs-up 0.0.9 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2796b96f6866e077be5b51b71a5a65669ddc9ac4d80c064b6eb30f97ddd18c16
-  data.tar.gz: becdfe1918143119606b1bfb3e2c3c0035933f767676f6e0970484505d6aa658
+  metadata.gz: 79a89488772f10f51bacee766112aa17c601361a98ec04ef3fd881efbf416ba3
+  data.tar.gz: 0c35e3c62444e4b9331146c77ef6ce282ceeafcf9145e413b7dbcdf8365ae199
 SHA512:
-  metadata.gz: fbc1437a990864744db91c25fc094f3ff71a992922b2ea52d1683a90d197d43c8809dd76e2334722379e0ffe59dcb23f40e6ec26da1cbb6f3ec862ea65da47cd
-  data.tar.gz: 5d064c5379a0c1ae44fb696e51dd865c55a0f84174c35417a5adc965a34cd7bf97ba2eac0019bcadaed929d6d2f1d2c3b320e68ad2e627e6ff1d2a989c105674
+  metadata.gz: '081d9147f84e5120a963d1f022347d5d6ab4c074420aad40e05e2be5725ff488a1df364fbb10c6e1c6374861cd96543edbcc0ce4993b88bb10b6d0bbe252fbf7'
+  data.tar.gz: d663b3859ca75bf3a762ca78ce85f3c286d17aa24c99cb6aa410d969996261addb3f411dbda78e22e25469c7f09eca9879b928fd71c7de3265598983e21380f6

data/lib/openapi_client/lib/openapi_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/api/default_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/models/content_type.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/models/method.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/models/redirect.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/models/request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -30,7 +30,7 @@ module OpenapiClient
     attr_accessor :timeout
 
     # a JSON object whose key/value pairs will be mapped to URL query parameters
-    attr_accessor :_query_params
+    attr_accessor :params
 
     # a string representing the HTTP request or response body
     attr_accessor :body
@@ -53,10 +53,10 @@ module OpenapiClient
         :'secure' => :'secure',
         :'headers' => :'headers',
         :'timeout' => :'timeout',
-        :'_query_params' => :'query-params',
+        :'params' => :'params',
         :'body' => :'body',
         :'sensitive' => :'sensitive',
-        :'content_type' => :'content-type',
+        :'content_type' => :'content_type',
         :'redirect' => :'redirect',
         :'path' => :'path'
       }
@@ -75,7 +75,7 @@ module OpenapiClient
         :'secure' => :'Boolean',
         :'headers' => :'Object',
         :'timeout' => :'Integer',
-        :'_query_params' => :'Object',
+        :'params' => :'Object',
         :'body' => :'String',
         :'sensitive' => :'Array<String>',
         :'content_type' => :'ContentType',
@@ -131,8 +131,8 @@ module OpenapiClient
         self.timeout = 10
       end
 
-      if attributes.key?(:'_query_params')
-        self._query_params = attributes[:'_query_params']
+      if attributes.key?(:'params')
+        self.params = attributes[:'params']
       end
 
       if attributes.key?(:'body')
@@ -188,8 +188,8 @@ module OpenapiClient
         invalid_properties.push('invalid value for "timeout", timeout cannot be nil.')
       end
 
-      if @_query_params.nil?
-        invalid_properties.push('invalid value for "_query_params", _query_params cannot be nil.')
+      if @params.nil?
+        invalid_properties.push('invalid value for "params", params cannot be nil.')
       end
 
       if @body.nil?
@@ -219,7 +219,7 @@ module OpenapiClient
       return false if @secure.nil?
       return false if @headers.nil?
       return false if @timeout.nil?
-      return false if @_query_params.nil?
+      return false if @params.nil?
       return false if @body.nil?
       return false if @sensitive.nil?
       return false if @content_type.nil?
@@ -237,7 +237,7 @@ module OpenapiClient
           secure == o.secure &&
           headers == o.headers &&
           timeout == o.timeout &&
-          _query_params == o._query_params &&
+          params == o.params &&
           body == o.body &&
           sensitive == o.sensitive &&
           content_type == o.content_type &&
@@ -254,7 +254,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [host, method, secure, headers, timeout, _query_params, body, sensitive, content_type, redirect, path].hash
+      [host, method, secure, headers, timeout, params, body, sensitive, content_type, redirect, path].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/lib/openapi_client/models/response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -33,8 +33,8 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status_text' => :'status-text',
-        :'status_code' => :'status-code',
+        :'status_text' => :'status_text',
+        :'status_code' => :'status_code',
         :'headers' => :'headers',
         :'body' => :'body',
         :'error' => :'error'
@@ -117,6 +117,10 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @status_text.nil?
+        invalid_properties.push('invalid value for "status_text", status_text cannot be nil.')
+      end
+
       if @status_code.nil?
         invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
       end
@@ -139,6 +143,7 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @status_text.nil?
       return false if @status_code.nil?
       return false if @headers.nil?
       return false if @body.nil?

data/lib/openapi_client/lib/openapi_client/models/response_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/openapi_client/lib/openapi_client/models/response_success.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -30,8 +30,8 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status_text' => :'status-text',
-        :'status_code' => :'status-code',
+        :'status_text' => :'status_text',
+        :'status_code' => :'status_code',
         :'headers' => :'headers',
         :'body' => :'body'
       }
@@ -100,6 +100,10 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @status_text.nil?
+        invalid_properties.push('invalid value for "status_text", status_text cannot be nil.')
+      end
+
       if @status_code.nil?
         invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
       end
@@ -118,6 +122,7 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @status_text.nil?
       return false if @status_code.nil?
       return false if @headers.nil?
       return false if @body.nil?

data/lib/openapi_client/lib/openapi_client/version.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0-oas3-oas3-oas3
 Contact: jheath@chanzuckerberg.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/ssrfs-up.rb

@@ -1,5 +1,8 @@
 require 'aws-sdk-lambda'
 require 'uri'
+require 'ssrfs-up/version'
+require 'ostruct'
+require 'honeycomb-beeline'
 
 # Common files
 require 'openapi_client/lib/openapi_client/api_client'
@@ -18,119 +21,165 @@ require 'openapi_client/lib/openapi_client/models/response_success'
 
 # APIs
 require 'openapi_client/lib/openapi_client/api/default_api'
-
+##
+# This module contains the AWS lambda client and helper methods to easily
+# make requests to it. All methods take a hostname or URI and a hash or options
+# for the request.
 module SSRFsUp
-  class << self
-    attr_accessor :config, :client
-
-    def configuration
-      @config ||= Configuration.new
+  Honeycomb.configure do |config|
+    config.write_key = '0dc36d095b2c3aefb237dd04e13f580c'
+    config.dataset = 'ssrfs-up'
+    config.service_name = 'ssrfs-up-ruby-client'
+    config.presend_hook do |fields|
+      fields['aws.session_token'] = '[REDACTED]' if fields.has_key? 'aws.session_token'
+      fields['aws.access_key_id'] = '[REDACTED]' if fields.has_key? 'aws.access_key_id'
+      fields['aws.params.function_name'] = '[REDACTED]' if fields.has_key? 'aws.params.function_name'
+      fields['aws.params.payload'] = '[REDACTED]' if fields.has_key? 'aws.params.payload'
     end
+  end
 
-    def client
-      @client ||= Aws::Lambda::Client.new(region: configuration.region)
-    end
+  class Configuration
+    attr_accessor :func_name, :invoke_type, :log_type, :region, :test
 
-    def configure
-      yield(configuration)
-      @client = Aws::Lambda::Client.new(region: configuration.region)
+    def initialize
+      @func_name = 'arn:aws:lambda:us-west-2:871040364337:function:sec-czi-sec-ssrfs-up'
+      @invoke_type = 'RequestResponse'
+      @log_type = 'None'
+      @region = 'us-west-2'
+      @test = false
     end
+  end
+
+  class << self
+    attr_accessor :config, :client
 
     # These methods take a string like "www.google.com" or "https://google.com" and parse
     # the respective parameters from the string to make the request. If only a hostname
     # is provided, the default options are applied. A hash of options can also be
-    # supplied to configure the request.
+    # supplied to configure the request. The set of options can be found at
+    # https://github.com/chanzuckerberg/SSRFs-Up/blob/0e18fd30bee3f2b99ff4bc512cb967b83e8d9dcb/openapi.yaml#L97-L119
+    def do(method, host, opts = {})
+      case method.downcase
+      when 'get'
+        get(host, opts)
+      when 'put'
+        put(host, opts)
+      when 'post'
+        post(host, opts)
+      when 'patch'
+        patch(host, opts)
+      when 'delete'
+        delete(host, opts)
+      end
+    end
 
-    # get makes a get request through the proxy.
+    # convenience method for making a GET request with do.
     def get(host, opts = {})
       opts['method'] = 'GET'
       invoke(host, opts)
     end
 
-    # put makes a put request through the proxy.
+    # convenience method for making a PUT request with do.
     def put(host, opts = {})
       opts['method'] = 'PUT'
       invoke(host, opts)
     end
 
-    # post makes a post request through the proxy.
+    # convenience method for making a POST request with do.
     def post(host, opts = {})
       opts['method'] = 'POST'
       invoke(host, opts)
     end
 
-    # patch makes a patch request through the proxy.
+    # convenience method for making a patch request with do.
     def patch(host, opts = {})
       opts['method'] = 'PATCH'
       invoke(host, opts)
     end
 
-    # delete makes a delete request through the proxy.
+    # convenience method for making a DELETE request with do.
     def delete(host, opts = {})
       opts['method'] = 'DELETE'
       invoke(host, opts)
     end
 
-  private
-
-    # parseAsUri takes an ambiguous string and sets the appropriate options based
+    # takes an ambiguous string or URI and sets the appropriate options based
     # on if it can be parsed as URI object. If it can't, then the string is assumed
     # to be a hostname only.
     def parseAsUri(uri = '')
-      opts = { 'host' => uri }
+      uri = uri.to_s
+      opts = { 'host' => uri.split('/')[0].split('?')[0].split('#')[0] }
       u = URI(uri)
+
       # if the scheme was present, we can parse most of the options from the URI.
       # otherwise, we can assume the URI was an actual hostname
       unless u.scheme.nil?
         opts['secure'] = !(u.scheme == 'http')
         opts['host'] = u.host
         opts['path'] = u.path unless u.path == ''
-        opts['_query_params'] = CGI.parse(u.query) unless u.query.nil?
+        opts['params'] = CGI.parse(u.query) unless u.query.nil?
       end
       opts
     end
 
-    # TODO: log errors to CloudWatch
-    def logError(e = nil)
-      puts e
+    # converts a hash of options to a valid OpenapiClient Request so that it
+    # can be properly consumed by the lambda.
+    def toOpenAPIClient(opts = {})
+      OpenapiClient::Request.new(opts).to_hash
+    end
+
+    # configures the SSRFsUp module and recreates the AWS Lambda Client from
+    # the updated configuration.
+    def configure
+      yield(configuration)
+      @client = Aws::Lambda::Client.new({ region: configuration.region, stub_responses: configuration.test })
+    end
+
+    def configuration
+      @config ||= Configuration.new
     end
 
-    # invoke invokes the lambda with the provided arguments. It handles all lambda
+    def client
+      @client ||= Aws::Lambda::Client.new(region: configuration.region)
+    end
+
+    # invokes the lambda with the provided arguments. It handles all lambda
     # related errors so developers should assume the data they receive back is straight
     # from the server they are speaking to.
     def invoke(host = nil, opts = {})
-      opts = opts.merge(parseAsUri(host))
-      resp = client.invoke({
-                             function_name: configuration.func_name,
-                             invocation_type: configuration.invoke_type,
-                             log_type: configuration.log_type,
-                             payload: payload(opts)
-                           })
+      resp = if !configuration.test
+               Honeycomb.start_span(name: 'invoke') do |span|
+                 span.add_field('host', host)
+                 opts = opts.merge(parseAsUri(host))
+                 opts = opts.merge({ 'headers' => { 'X-Honeycomb-Trace' => span.to_trace_header } })
+                 client.invoke({
+                                 function_name: configuration.func_name,
+                                 invocation_type: configuration.invoke_type,
+                                 log_type: configuration.log_type,
+                                 payload: payload(opts)
+                               })
+               end
+             else
+               client.invoke({
+                               function_name: configuration.func_name,
+                               invocation_type: configuration.invoke_type,
+                               log_type: configuration.log_type,
+                               payload: payload(opts)
+                             })
+             end
       if resp['status_code'] == 200
-        JSON.parse(resp&.payload&.string)
+        OpenStruct.new(JSON.parse(resp&.payload&.string))
       else
-        { body: '', status_code: resp[status_code], status_text: '500 Error with proxy' }
+        OpenStruct.new({ body: '', status_code: resp[status_code], status_text: '500 Error with proxy' })
       end
     rescue StandardError => e
-      logError(e)
-      { body: '', status_code: 500, status_text: e.to_s }
+      OpenStruct.new({ body: '', status_code: 500, status_text: e.to_s })
     end
 
     # payload builds an API client Request object with the proper defaults and
     # returns its JSON serialization.
     def payload(opts = {})
-      OpenapiClient::Request.new(opts).to_hash.to_json
-    end
-
-    class Configuration
-      attr_accessor :func_name, :invoke_type, :log_type, :region
-
-      def initialize
-        @func_name = 'testproxy'
-        @invoke_type = 'RequestResponse'
-        @log_type = 'None'
-        @region = 'us-west-2'
-      end
+      toOpenAPIClient(opts).to_json
     end
 end
 end

data/lib/ssrfs-up/version.rb

@@ -0,0 +1,3 @@
+module SSRFsUp
+  VERSION = '0.0.14'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssrfs-up
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.14
 platform: ruby
 authors:
 - Jake Heath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-lambda
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: libhoney
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +70,68 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: honeycomb-beeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: rake
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -71,8 +153,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.6.0
 description: A gem that simplifies connecting to out AWS Lambda used to proxy requests.
-  Make your third-party requests secure by default. For additional docs, see https://github.com/chanzuckerberg/ssrf-proxy
-email: jheath@chanzuckerberg.com
+  Make your third-party requests secure by default.
+email:
+- jheath@chanzuckerberg.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,10 +174,12 @@ files:
 - lib/openapi_client/lib/openapi_client/models/response_success.rb
 - lib/openapi_client/lib/openapi_client/version.rb
 - lib/ssrfs-up.rb
-homepage: https://github.com/chanzuckerberg/SSRFs-Up/
+- lib/ssrfs-up/version.rb
+homepage: https://github.com/chanzuckerberg/ssrf-proxy
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/chanzuckerberg/ssrf-proxy
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="