as2 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e21a1d3326b7db528a205964fb6c5e99656ea20e4ad7dcba0877088fdd86104
-  data.tar.gz: c46538361b3cdb28f6b97a602465adea7dea2f348dbdc54fd18c33ca7a496801
+  metadata.gz: 7a467f304fd7955e9f787078b8bbda6277e111e84e75d2cc02c935d6ccc00916
+  data.tar.gz: b75996e0b5064d1b4133f9ed8db0b9f629cb44746ade335edcd3a2fa04de0edf
 SHA512:
-  metadata.gz: 52189a26063743097ea72abfe0b12e21866417ab60af8633b581eab7c1902ebb32bf904538daf4301f5320c0cbfd730d94c1aa14f6a365d0ea270158f649565c
-  data.tar.gz: ec40485fcd9e7f7f38cbc3649c3b7c84986ebc1be2242a3208c9563d42bea239fb8d4f38a73bd0ce580e54e2371890a45689d138b55c5eccc0c489b6c7526a45
+  metadata.gz: b8b50c0291eed98d9f74333e094bf1a59cf4bedb987592082dddc04118e319dd85121f8434391fb473783320b6388ec836d0fe54901b02b8c3cdf70f95eb93b6
+  data.tar.gz: db4e30dba47bd613b3b9b5e0e47d33951e527a31249af79ce7f2073c66035cc9a3aa3a8ba5a88c0163b4e06eec814d6ac2bf48ee060935cc22ec57762bdd2b10

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.11.0 September 14, 2023
+
+  * Allow configuration of which encryption cipher to use when sending outbound messages. [#35](https://github.com/alexdean/as2/pull/35)
+
 ## 0.10.0 September 13, 2023
 
 support for separate signing & encryption certificates for partners. [#34](https://github.com/alexdean/as2/pull/34)

data/lib/as2/client.rb

@@ -8,6 +8,10 @@ module As2
       ['v0', 'v1']
     end
 
+    def self.valid_encryption_ciphers
+      OpenSSL::Cipher.ciphers
+    end
+
     # @param [As2::Config::Partner,String] partner The partner to send a message to.
     #   If a string is given, it should be a partner name which has been registered
     #   via a call to #add_partner.
@@ -45,6 +49,10 @@ module As2
     #   * If content parameter is specified, file_name is only used to tell the
     #     partner the original name of the file.
     #
+    # TODO: refactor to separate "build an outbound message" from "send an outbound message"
+    # main benefit would be allowing the test suite to be more straightforward.
+    # (wouldn't need webmock just to verify what kind of message we built...)
+    #
     # @param [String] file_name
     # @param [String] content
     # @param [String] content_type This is the MIME Content-Type describing the `content` param,
@@ -82,8 +90,11 @@ module As2
                                          file_name: file_name
                                        )
 
-      cipher = OpenSSL::Cipher::AES256.new(:CBC) # default, but we might have to make this configurable
-      encrypted = OpenSSL::PKCS7.encrypt([@partner.encryption_certificate], request_body, cipher)
+      encrypted = OpenSSL::PKCS7.encrypt(
+                    [@partner.encryption_certificate],
+                    request_body,
+                    @partner.encryption_cipher_instance
+                  )
 
       # > HTTP can handle binary data and so there is no need to use the
       # > content transfer encodings of MIME

data/lib/as2/config.rb

@@ -12,7 +12,12 @@ module As2
       end
     end
 
-    class Partner < Struct.new :name, :url, :encryption_certificate, :signing_certificate, :tls_verify_mode, :mdn_format, :outbound_format
+    class Partner < Struct.new :name, :url, :encryption_certificate, :encryption_cipher, :signing_certificate, :tls_verify_mode, :mdn_format, :outbound_format
+      def initialize
+        # set default.
+        self.encryption_cipher = 'aes-256-cbc'
+      end
+
       def url=(url)
         if url.kind_of? String
           self['url'] = URI.parse url
@@ -49,6 +54,19 @@ module As2
         self['encryption_certificate'] = As2::Config.build_certificate(certificate)
       end
 
+      def encryption_cipher=(cipher)
+        cipher_s = cipher.to_s
+        valid_ciphers = As2::Client.valid_encryption_ciphers
+        if !valid_ciphers.include?(cipher_s)
+          raise ArgumentError, "encryption_cipher '#{cipher_s}' must be one of #{valid_ciphers.inspect}"
+        end
+        self['encryption_cipher'] = cipher_s
+      end
+
+      def encryption_cipher_instance
+        OpenSSL::Cipher.new(encryption_cipher)
+      end
+
       def signing_certificate=(certificate)
         self['signing_certificate'] = As2::Config.build_certificate(certificate)
       end

data/lib/as2/version.rb

@@ -1,3 +1,3 @@
 module As2
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: as2
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OfficeLuv
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail