net-smtp 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238243a17f2718efcc1c1ca44ac307df60c676d29f719298a599a2ff74e7b321
-  data.tar.gz: 7e7e7c04e9a4f570512c30102376b7b53aef1e51f7b4a987ef9c56655e51ab62
+  metadata.gz: a873c949eb563b55b9ea2d29eaecdf2bad09006b7cc2aab14954971021619de1
+  data.tar.gz: c7ed69e3a3e56805953b5ff7ed8f31288eeb4bd113a13e559b38fca5fd85e1cf
 SHA512:
-  metadata.gz: f2ee31d1382efcc8757ac8ccea1003060a391d0f809f3e9ce4abcbb3374d7e125344d774875712a32b046ccde0bb5dc7a4c6aafd6aa80da3dc33230a7d3449f8
-  data.tar.gz: 19a97301c3d8bb9ad4a0962cb862711d5f1693773b56bbccb4bf25e219aae7899bc174c9b2117747df82fdf88031cce06132b6398215dd645139535b83c57e7d
+  metadata.gz: 87fcd365f156b81c1124182b09973665607f201909e3bdd8463a007dadda060f6cde0069d4c8db9127233a61531b276b9a0b15e93b77f691a04baacd4c09c6cc
+  data.tar.gz: d8930794d97b2c1dbb8e507bc72b6a4e2f58da8f7e14a6546e87aed8082bbaf7be7c0cde7adeb6c80f66d57c6237edeaf5bc07fbbba6e63905e7c5dcf3777ba1

data/lib/net/smtp.rb

@@ -31,6 +31,17 @@ module Net
   module SMTPError
     # This *class* is a module for backward compatibility.
     # In later release, this module becomes a class.
+
+    attr_reader :response
+
+    def initialize(response, message: nil)
+      @response = response
+      @message = message
+    end
+
+    def message
+      @message || response.message
+    end
   end
 
   # Represents an SMTP authentication error.
@@ -168,7 +179,7 @@ module Net
   #                     user: 'Your Account', secret: 'Your Password', authtype: :cram_md5)
   #
   class SMTP < Protocol
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
 
     Revision = %q$Revision$.split[1]
 
@@ -191,12 +202,9 @@ module Net
       alias default_ssl_port default_tls_port
     end
 
-    def SMTP.default_ssl_context(verify_peer=true)
+    def SMTP.default_ssl_context(ssl_context_params = nil)
       context = OpenSSL::SSL::SSLContext.new
-      context.verify_mode = verify_peer ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
-      store = OpenSSL::X509::Store.new
-      store.set_default_paths
-      context.cert_store = store
+      context.set_params(ssl_context_params ? ssl_context_params : {})
       context
     end
 
@@ -207,11 +215,23 @@ module Net
     # server.  +port+ is the port to connect to; it defaults to
     # port 25.
     #
+    # If +tls+ is true, enable TLS. The default is false.
+    # If +starttls+ is :always, enable STARTTLS, if +:auto+, use STARTTLS when the server supports it,
+    # if false, disable STARTTLS.
+    #
+    # If +tls_verify+ is true, verify the server's certificate. The default is true.
+    # If the hostname in the server certificate is different from +address+,
+    # it can be specified with +tls_hostname+.
+    #
+    # Additional SSLContext params can be added to +ssl_context_params+ hash argument and are passed to
+    # +OpenSSL::SSL::SSLContext#set_params+
+    #
+    # +tls_verify: true+ is equivalent to +ssl_context_params: { verify_mode: OpenSSL::SSL::VERIFY_PEER }+.
     # This method does not open the TCP connection.  You can use
     # SMTP.start instead of SMTP.new if you want to do everything
     # at once.  Otherwise, follow SMTP.new with SMTP#start.
     #
-    def initialize(address, port = nil)
+    def initialize(address, port = nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil)
       @address = address
       @port = (port || SMTP.default_port)
       @esmtp = true
@@ -222,10 +242,13 @@ module Net
       @read_timeout = 60
       @error_occurred = false
       @debug_output = nil
-      @tls = false
-      @starttls = :auto
+      @tls = tls
+      @starttls = starttls
       @ssl_context_tls = nil
       @ssl_context_starttls = nil
+      @tls_verify = tls_verify
+      @tls_hostname = tls_hostname
+      @ssl_context_params = ssl_context_params
     end
 
     # Provide human-readable stringification of class state.
@@ -301,7 +324,7 @@ module Net
     # this object.  Must be called before the connection is established
     # to have any effect.  +context+ is a OpenSSL::SSL::SSLContext object.
     def enable_tls(context = nil)
-      raise 'openssl library not installed' unless defined?(OpenSSL)
+      raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
       raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @starttls == :always
       @tls = true
       @ssl_context_tls = context
@@ -338,7 +361,7 @@ module Net
     # Enables SMTP/TLS (STARTTLS) for this object.
     # +context+ is a OpenSSL::SSL::SSLContext object.
     def enable_starttls(context = nil)
-      raise 'openssl library not installed' unless defined?(OpenSSL)
+      raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
       raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @tls
       @starttls = :always
       @ssl_context_starttls = context
@@ -347,7 +370,7 @@ module Net
     # Enables SMTP/TLS (STARTTLS) for this object if server accepts.
     # +context+ is a OpenSSL::SSL::SSLContext object.
     def enable_starttls_auto(context = nil)
-      raise 'openssl library not installed' unless defined?(OpenSSL)
+      raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
       raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @tls
       @starttls = :auto
       @ssl_context_starttls = context
@@ -409,14 +432,14 @@ module Net
 
     #
     # :call-seq:
-    #  start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil, tls_verify: true, tls_hostname: nil) { |smtp| ... }
+    #  start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil) { |smtp| ... }
     #  start(address, port = nil, helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }
     #
     # Creates a new Net::SMTP object and connects to the server.
     #
     # This method is equivalent to:
     #
-    #   Net::SMTP.new(address, port).start(helo: helo_domain, user: account, secret: password, authtype: authtype, tls_verify: flag, tls_hostname: hostname)
+    #   Net::SMTP.new(address, port).start(helo: helo_domain, user: account, secret: password, authtype: authtype, tls_verify: flag, tls_hostname: hostname, ssl_context_params: nil)
     #
     # === Example
     #
@@ -446,10 +469,20 @@ module Net
     # or other authentication token; and +authtype+ is the authentication
     # type, one of :plain, :login, or :cram_md5.  See the discussion of
     # SMTP Authentication in the overview notes.
+    #
+    # If +tls+ is true, enable TLS. The default is false.
+    # If +starttls+ is :always, enable STARTTLS, if +:auto+, use STARTTLS when the server supports it,
+    # if false, disable STARTTLS.
+    #
     # If +tls_verify+ is true, verify the server's certificate. The default is true.
     # If the hostname in the server certificate is different from +address+,
     # it can be specified with +tls_hostname+.
     #
+    # Additional SSLContext params can be added to +ssl_context_params+ hash argument and are passed to
+    # +OpenSSL::SSL::SSLContext#set_params+
+    #
+    # +tls_verify: true+ is equivalent to +ssl_context_params: { verify_mode: OpenSSL::SSL::VERIFY_PEER }+.
+    #
     # === Errors
     #
     # This method may raise:
@@ -465,14 +498,15 @@ module Net
     #
     def SMTP.start(address, port = nil, *args, helo: nil,
                    user: nil, secret: nil, password: nil, authtype: nil,
-                   tls_verify: true, tls_hostname: nil,
+                   tls: false, starttls: :auto,
+                   tls_verify: true, tls_hostname: nil, ssl_context_params: nil,
                    &block)
       raise ArgumentError, "wrong number of arguments (given #{args.size + 2}, expected 1..6)" if args.size > 4
       helo ||= args[0] || 'localhost'
       user ||= args[1]
       secret ||= password || args[2]
       authtype ||= args[3]
-      new(address, port).start(helo: helo, user: user, secret: secret, authtype: authtype, tls_verify: tls_verify, tls_hostname: tls_hostname, &block)
+      new(address, port, tls: tls, starttls: starttls, tls_verify: tls_verify, tls_hostname: tls_hostname, ssl_context_params: ssl_context_params).start(helo: helo, user: user, secret: secret, authtype: authtype, &block)
     end
 
     # +true+ if the SMTP session has been started.
@@ -482,7 +516,7 @@ module Net
 
     #
     # :call-seq:
-    #  start(helo: 'localhost', user: nil, secret: nil, authtype: nil, tls_verify: true, tls_hostname: nil) { |smtp| ... }
+    #  start(helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... }
     #  start(helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }
     #
     # Opens a TCP connection and starts the SMTP session.
@@ -497,9 +531,6 @@ module Net
     # the type of authentication to attempt; it must be one of
     # :login, :plain, and :cram_md5.  See the notes on SMTP Authentication
     # in the overview.
-    # If +tls_verify+ is true, verify the server's certificate. The default is true.
-    # If the hostname in the server certificate is different from +address+,
-    # it can be specified with +tls_hostname+.
     #
     # === Block Usage
     #
@@ -538,20 +569,24 @@ module Net
     # * Net::ReadTimeout
     # * IOError
     #
-    def start(*args, helo: nil,
-              user: nil, secret: nil, password: nil, authtype: nil, tls_verify: true, tls_hostname: nil)
+    def start(*args, helo: nil, user: nil, secret: nil, password: nil, authtype: nil)
       raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..4)" if args.size > 4
       helo ||= args[0] || 'localhost'
       user ||= args[1]
       secret ||= password || args[2]
       authtype ||= args[3]
-      if @tls && @ssl_context_tls.nil?
-        @ssl_context_tls = SMTP.default_ssl_context(tls_verify)
-      end
-      if @starttls && @ssl_context_starttls.nil?
-        @ssl_context_starttls = SMTP.default_ssl_context(tls_verify)
+      if defined?(OpenSSL::VERSION)
+        ssl_context_params = @ssl_context_params || {}
+        unless ssl_context_params.has_key?(:verify_mode)
+          ssl_context_params[:verify_mode] = @tls_verify ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+        end
+        if @tls && @ssl_context_tls.nil?
+          @ssl_context_tls = SMTP.default_ssl_context(ssl_context_params)
+        end
+        if @starttls && @ssl_context_starttls.nil?
+          @ssl_context_starttls = SMTP.default_ssl_context(ssl_context_params)
+        end
       end
-      @tls_hostname = tls_hostname
       if block_given?
         begin
           do_start helo, user, secret, authtype
@@ -575,7 +610,12 @@ module Net
     private
 
     def tcp_socket(address, port)
-      TCPSocket.open address, port
+      begin
+        Socket.tcp address, port, nil, nil, connect_timeout: @open_timeout
+      rescue Errno::ETIMEDOUT #raise Net:OpenTimeout instead for compatibility with previous versions
+        raise Net::OpenTimeout, "Timeout to open TCP connection to "\
+          "#{address}:#{port} (exceeds #{@open_timeout} seconds)"
+      end
     end
 
     def do_start(helo_domain, user, secret, authtype)
@@ -584,17 +624,14 @@ module Net
         check_auth_method(authtype || DEFAULT_AUTH_TYPE)
         check_auth_args user, secret
       end
-      s = Timeout.timeout(@open_timeout, Net::OpenTimeout) do
-        tcp_socket(@address, @port)
-      end
+      s = tcp_socket(@address, @port)
       logging "Connection opened: #{@address}:#{@port}"
       @socket = new_internet_message_io(tls? ? tlsconnect(s, @ssl_context_tls) : s)
       check_response critical { recv_response() }
       do_helo helo_domain
       if ! tls? and (starttls_always? or (capable_starttls? and starttls_auto?))
         unless capable_starttls?
-          raise SMTPUnsupportedCommand,
-              "STARTTLS is not supported on this server"
+          raise SMTPUnsupportedCommand.new(nil, message: "STARTTLS is not supported on this server")
         end
         starttls
         @socket = new_internet_message_io(tlsconnect(s, @ssl_context_starttls))
@@ -620,11 +657,8 @@ module Net
       s = ssl_socket(s, context)
       logging "TLS connection started"
       s.sync_close = true
-      s.hostname = @tls_hostname || @address if s.respond_to? :hostname=
+      s.hostname = @tls_hostname || @address
       ssl_socket_connect(s, @open_timeout)
-      if context.verify_mode && context.verify_mode != OpenSSL::SSL::VERIFY_NONE
-        s.post_connection_check(@tls_hostname || @address)
-      end
       verified = true
       s
     ensure
@@ -1000,25 +1034,25 @@ module Net
 
     def check_response(res)
       unless res.success?
-        raise res.exception_class, res.message
+        raise res.exception_class.new(res)
       end
     end
 
     def check_continue(res)
       unless res.continue?
-        raise SMTPUnknownError, "could not get 3xx (#{res.status}: #{res.string})"
+        raise SMTPUnknownError.new(res, message: "could not get 3xx (#{res.status}: #{res.string})")
       end
     end
 
     def check_auth_response(res)
       unless res.success?
-        raise SMTPAuthenticationError, res.message
+        raise SMTPAuthenticationError.new(res)
       end
     end
 
     def check_auth_continue(res)
       unless res.continue?
-        raise res.exception_class, res.message
+        raise res.exception_class.new(res)
       end
     end
 

data/net-smtp.gemspec

@@ -22,12 +22,14 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = %w[
+    LICENSE.txt
+    lib/net/smtp.rb
+    net-smtp.gemspec
+  ]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "net-protocol"
+  spec.add_dependency "digest"
+  spec.add_dependency "timeout"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-smtp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yukihiro Matsumoto
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: digest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple Mail Transfer Protocol client library for Ruby.
 email:
 - matz@ruby-lang.org
@@ -31,15 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
-- Gemfile
 - LICENSE.txt
-- NEWS.md
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/net/smtp.rb
 - net-smtp.gemspec
 homepage: https://github.com/ruby/net-smtp
@@ -64,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Simple Mail Transfer Protocol client library for Ruby.

data/.github/workflows/test.yml

@@ -1,24 +0,0 @@
-name: test
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
-    strategy:
-      matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
-        os: [ ubuntu-latest, macos-latest ]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: |
-        gem install bundler --no-document
-        bundle install
-    - name: Run test
-      run: rake test

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock

data/Gemfile

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-group :development do
-  gem "bundler"
-  gem "rake"
-  gem "test-unit"
-end

data/NEWS.md

@@ -1,44 +0,0 @@
-# NEWS
-
-## Version 0.2.0 (2020-11-15)
-
-### Incompatible changes
-
-* Verify the server's certificate by default.
-  If you don't want verification, specify `start(tls_verify: false)`.
-  <https://github.com/ruby/net-smtp/pull/12>
-
-* Use STARTTLS by default if possible.
-  If you don't want starttls, specify:
-      ```
-      smtp = Net::SMTP.new(hostname, port)
-      smtp.disable_starttls
-      smtp.start do |s|
-        s.send_message ....
-      end
-      ```
-  <https://github.com/ruby/net-smtp/pull/9>
-
-### Improvements
-
-* Net::SMTP.start and Net::SMTP#start arguments are keyword arguments.
-      ```
-      start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... }
-      ```
-  `password` is an alias of `secret`.
-  <https://github.com/ruby/net-smtp/pull/7>
-
-* Add `tls_hostname` parameter to `start()`.
-  If you want to use a different hostname than the certificate for the connection, you can specify the certificate hostname with `tls_hostname`.
-  <https://github.com/ruby/net-smtp/pull/14>
-
-* Add SNI support to net/smtp <https://github.com/ruby/net-smtp/pull/4>
-
-### Fixes
-
-* enable_starttls before disable_tls causes an error. <https://github.com/ruby/net-smtp/pull/10>
-* TLS should not check the hostname when verify_mode is disabled. <https://github.com/ruby/net-smtp/pull/6>
-
-## Version 0.1.0 (2019-12-03)
-
-This is the first release of net-smtp gem.

data/README.md

@@ -1,97 +0,0 @@
-# Net::SMTP
-
-This library provides functionality to send internet mail via SMTP, the Simple Mail Transfer Protocol.
-
-For details of SMTP itself, see [RFC2821] (http://www.ietf.org/rfc/rfc2821.txt).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'net-smtp'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install net-smtp
-
-## Usage
-
-### Sending Messages
-
-You must open a connection to an SMTP server before sending messages.
-The first argument is the address of your SMTP server, and the second
-argument is the port number. Using SMTP.start with a block is the simplest
-way to do this. This way, the SMTP connection is closed automatically
-after the block is executed.
-
-```ruby
-require 'net/smtp'
-Net::SMTP.start('your.smtp.server', 25) do |smtp|
-  # Use the SMTP object smtp only in this block.
-end
-```
-
-Replace 'your.smtp.server' with your SMTP server. Normally
-your system manager or internet provider supplies a server
-for you.
-
-Then you can send messages.
-
-```ruby
-msgstr = <<END_OF_MESSAGE
-From: Your Name <your@mail.address>
-To: Destination Address <someone@example.com>
-Subject: test message
-Date: Sat, 23 Jun 2001 16:26:43 +0900
-Message-Id: <unique.message.id.string@example.com>
-
-This is a test message.
-END_OF_MESSAGE
-
-require 'net/smtp'
-Net::SMTP.start('your.smtp.server', 25) do |smtp|
-  smtp.send_message msgstr,
-                    'your@mail.address',
-                    'his_address@example.com'
-end
-```
-
-### Closing the Session
-
-You MUST close the SMTP session after sending messages, by calling
-the #finish method:
-
-```ruby
-# using SMTP#finish
-smtp = Net::SMTP.start('your.smtp.server', 25)
-smtp.send_message msgstr, 'from@address', 'to@address'
-smtp.finish
-```
-
-You can also use the block form of SMTP.start/SMTP#start.  This closes
-the SMTP session automatically:
-
-```ruby
-# using block form of SMTP.start
-Net::SMTP.start('your.smtp.server', 25) do |smtp|
-  smtp.send_message msgstr, 'from@address', 'to@address'
-end
-```
-
-I strongly recommend this scheme.  This form is simpler and more robust.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/net-smtp.

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/test_*.rb']
-end
-
-task :default => [:test]

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "net/smtp"
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install