as2 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78765b4a0fba8aaa7e3531ee9e3841a0774d72b6a1d09b18a69b53117cf26e22
-  data.tar.gz: c020c365f57a2dd428501b453bb349483bc98baf6db263dab7dfdfbab33b70a6
+  metadata.gz: 96ec1c65d6997fc278267320f6228096129a87752c52127fdf2c9a6d6b1a8b43
+  data.tar.gz: b9305a892d2833a59ee286567132cee1b060936ae1f87f80d0de36a6660a6d2b
 SHA512:
-  metadata.gz: 13155476fe9dab95fa56e29ec8dc842c86d4cdba0bf296aec518801d4ff8ef3f963bdb7e20d9e17bbc58bfdf334d9c760ccd712b267f70882b8e7ec79fa9230a
-  data.tar.gz: 1c6806d55b297222c0133e27f53914143ba0b3b35891c8076e93befe9d375534551b492890092432015a793dd88d97d8489ce69635e6ceeb8495f00880c5bd82
+  metadata.gz: 0c0aab2fb5d4282559cd0938d0bc540f0061a65d1a5eba7aa8f067a1f85fa746e599afeac5a9a4567456a737f2242bb73748b8460e4e398d612410536a3cafb8
+  data.tar.gz: 480ecc3810c376168a5778612c67c2db4eac48c0ea2da2fb782ba247ff0bc6400765b9b98b2835a7da9cd62d7cfdc37043dbee5b1278d3618c7782cd150b2182

data/.github/workflows/test.yml

@@ -9,26 +9,26 @@ name: test suite
 
 on:
   push:
-    branches: '**'
+    branches: "**"
 
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: bundle exec rake test
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.8.0, August 25, 2023
+
+  * Quote AS2-From/AS2-To identifiers which contain spaces. [#30](https://github.com/alexdean/as2/pull/30)
+  * Small improvements to aid integration testing with partners. [#31](https://github.com/alexdean/as2/pull/31)
+
 ## 0.7.0, August 25, 2023
 
 Two improvements in compatibility with IBM Sterling, which could not understand

data/lib/as2/client/result.rb

@@ -1,9 +1,10 @@
 module As2
   class Client
     class Result
-      attr_reader :response, :mic_matched, :mid_matched, :body, :disposition, :signature_verification_error, :exception, :outbound_message_id
+      attr_reader :request, :response, :mic_matched, :mid_matched, :body, :disposition, :signature_verification_error, :exception, :outbound_message_id
 
-      def initialize(response:, mic_matched:, mid_matched:, body:, disposition:, signature_verification_error:, exception:, outbound_message_id:)
+      def initialize(request:, response:, mic_matched:, mid_matched:, body:, disposition:, signature_verification_error:, exception:, outbound_message_id:)
+        @request = request
         @response = response
         @mic_matched = mic_matched
         @mid_matched = mid_matched

data/lib/as2/client.rb

@@ -56,8 +56,8 @@ module As2
 
       req = Net::HTTP::Post.new @partner.url.path
       req['AS2-Version'] = '1.0' # 1.1 includes compression support, which we dont implement.
-      req['AS2-From'] = as2_from
-      req['AS2-To'] = as2_to
+      req['AS2-From'] = As2.quoted_system_identifier(as2_from)
+      req['AS2-To'] = As2.quoted_system_identifier(as2_to)
       req['Subject'] = 'AS2 Transaction'
       req['Content-Type'] = 'application/pkcs7-mime; smime-type=enveloped-data; name=smime.p7m'
       req['Date'] = Time.now.rfc2822
@@ -99,9 +99,16 @@ module As2
         # note: to pass this traffic through a debugging proxy (like Charles)
         # set ENV['http_proxy'].
         http = Net::HTTP.new(@partner.url.host, @partner.url.port)
-        http.use_ssl = @partner.url.scheme == 'https'
+
+        use_ssl = @partner.url.scheme == 'https'
+        http.use_ssl = use_ssl
+        if use_ssl
+          if @partner.tls_verify_mode
+            http.verify_mode = @partner.tls_verify_mode
+          end
+        end
+
         # http.set_debug_output $stderr
-        # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
         http.start do
           resp = http.request(req)
@@ -120,6 +127,7 @@ module As2
       end
 
       Result.new(
+        request: req,
         response: resp,
         mic_matched: mdn_report[:mic_matched],
         mid_matched: mdn_report[:mid_matched],

data/lib/as2/config.rb

@@ -12,7 +12,7 @@ module As2
       end
     end
 
-    class Partner < Struct.new :name, :url, :certificate, :mdn_format, :outbound_format
+    class Partner < Struct.new :name, :url, :certificate, :tls_verify_mode, :mdn_format, :outbound_format
       def url=(url)
         if url.kind_of? String
           self['url'] = URI.parse url
@@ -42,6 +42,17 @@ module As2
       def certificate=(certificate)
         self['certificate'] = As2::Config.build_certificate(certificate)
       end
+
+      # if set, will be used for SSL transmissions.
+      # @see `verify_mode` in https://ruby-doc.org/stdlib-2.7.1/libdoc/net/http/rdoc/Net/HTTP.html
+      def tls_verify_mode=(mode)
+        valid_modes = [nil, OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER]
+        if !valid_modes.include?(mode)
+          raise ArgumentError, "tls_verify_mode '#{mode}' must be one of #{valid_modes.inspect}"
+        end
+
+        self['tls_verify_mode'] = mode
+      end
     end
 
     class ServerInfo < Struct.new :name, :url, :certificate, :pkey, :domain

data/lib/as2/server.rb

@@ -69,8 +69,8 @@ module As2
 
       options = {
         'Reporting-UA' => @server_info.name,
-        'Original-Recipient' => "rfc822; #{@server_info.name}",
-        'Final-Recipient' => "rfc822; #{@server_info.name}",
+        'Original-Recipient' => "rfc822; #{As2.quoted_system_identifier(@server_info.name)}",
+        'Final-Recipient' => "rfc822; #{As2.quoted_system_identifier(@server_info.name)}",
         'Original-Message-ID' => env['HTTP_MESSAGE_ID']
       }
       if failed
@@ -148,8 +148,8 @@ module As2
       # TODO: if MIME-Version header is actually needed, should extract it out of smime_signed.
       headers['MIME-Version'] = '1.0'
       headers['Message-ID'] = As2.generate_message_id(@server_info)
-      headers['AS2-From'] = @server_info.name
-      headers['AS2-To'] = as2_to
+      headers['AS2-From'] = As2.quoted_system_identifier(@server_info.name)
+      headers['AS2-To'] = As2.quoted_system_identifier(as2_to)
       headers['AS2-Version'] = '1.0'
       headers['Connection'] = 'close'
 
@@ -191,8 +191,8 @@ module As2
       headers['Content-Type'] = "multipart/signed; protocol=\"application/pkcs7-signature\"; micalg=\"#{micalg}\"; boundary=\"#{boundary}\""
       headers['MIME-Version'] = '1.0'
       headers['Message-ID'] = As2.generate_message_id(@server_info)
-      headers['AS2-From'] = @server_info.name
-      headers['AS2-To'] = as2_to
+      headers['AS2-From'] = As2.quoted_system_identifier(@server_info.name)
+      headers['AS2-To'] = As2.quoted_system_identifier(as2_to)
       headers['AS2-Version'] = '1.0'
       headers['Connection'] = 'close'
 

data/lib/as2/version.rb

@@ -1,3 +1,3 @@
 module As2
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/as2.rb

@@ -35,4 +35,13 @@ module As2
     parsed = As2::Parser::DispositionNotificationOptions.parse(disposition_notification_options)
     Array(parsed['signed-receipt-micalg']).find { |m| As2::DigestSelector.valid?(m) }
   end
+
+  # surround an As2-From/As2-To value with double-quotes, if it contains a space.
+  def self.quoted_system_identifier(name)
+    if name.to_s.include?(' ')
+      "\"#{name}\""
+    else
+      name
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: as2
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - OfficeLuv