net-imap 0.3.1 → 0.3.2

data/rakelib/rfcs.rake

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+RFCS = {
+
+  # Historic IMAP RFCs
+  822  => "Internet Message Format (OBSOLETE)",
+  1730 => "IMAP4 (OBSOLETE)",
+  1731 => "IMAP4 Authentication Mechanisms (OBSOLETE)",
+  2060 => "IMAP4rev1 (OBSOLETE)",
+  2061 => "IMAP4 Compatibility with IMAP2bis",
+  2062 => "Internet Message Access Protocol - Obsolete Syntax",
+  2086 => "IMAP ACL (OBSOLETE)",
+  2087 => "IMAP QUOTA (OBSOLETE)",
+  2088 => "IMAP LITERAL+ (OBSOLETE)",
+  2095 => "IMAP/POP AUTHorize Extension for CRAM-MD5 (OBSOLETE)",
+  2192 => "IMAP URL Scheme (OBSOLETE)",
+  2222 => "SASL (OBSOLETE)",
+  2359 => "IMAP UIDPLUS (OBSOLETE)",
+  2822 => "Internet Message Format (OBSOLETE)",
+  3348 => "IMAP CHILDREN (OBSOLETED)",
+  4551 => "IMAP CONDSTORE (OBSOLETE)",
+  5162 => "IMAP QRESYNC (OBSOLETE)",
+  6237 => "IMAP MULTISEARCH (OBSOLETE)",
+
+  # Core IMAP RFCs
+  3501 => "IMAP4rev1", # supported by nearly all email servers
+  4466 => "Collected Extensions to IMAP4 ABNF",
+  9051 => "IMAP4rev2", # not widely supported yet
+
+  # RFC-9051 Normative References (not a complete list)
+  2152 => "UTF-7",
+  2180 => "IMAP4 Multi-Accessed Mailbox Practice",
+  2683 => "IMAP4 Implementation Recommendations",
+  3503 => "Message Disposition Notification (MDN) profile IMAP",
+  5234 => "ABNF",
+  5788 => "IMAP4 keyword registry",
+
+  # Internet Message format and envelope and body structure
+  5322 => "Internet Message Format (current)",
+
+  1864 => "[MD5]: The Content-MD5 Header Field",
+  2045 => "[MIME-IMB]:  MIME Part One: Format of Internet Message Bodies",
+  2046 => "[MIME-IMT]:  MIME Part Two: Media Types",
+  2047 => "[MIME-HDRS]: MIME Part Three: Header Extensions for Non-ASCII Text",
+  2183 => "[DISPOSITION]: The Content-Disposition Header",
+  2231 => "MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations",
+  2557 => "[LOCATION]: MIME Encapsulation of Aggregate Documents",
+  2978 => "[CHARSET]: IANA Charset Registration Procedures, BCP 19",
+  3282 => "[LANGUAGE-TAGS]: Content Language Headers",
+  6532 => "[I18N-HDRS]: Internationalized Email Headers",
+
+  # SASL
+  4422 => "SASL, EXTERNAL",
+
+  # stringprep
+  3454 => "stringprep",
+  4013 => "SASLprep",
+  8265 => "PRECIS", # obsoletes SASLprep?
+
+  # SASL mechanisms (not a complete list)
+  2195 => "SASL CRAM-MD5",
+  4505 => "SASL ANONYMOUS",
+  4616 => "SASL PLAIN",
+  4752 => "SASL GSSAPI (Kerberos V5)",
+  5801 => "SASL GS2-*, GS2-KRB5",
+  5802 => "SASL SCRAM-*, SCRAM-SHA-1, SCRAM-SHA1-PLUS",
+  5803 => "LDAP Schema for Storing SCRAM Secrets",
+  6331 => "SASL DIGEST-MD5",
+  6595 => "SASL SAML20",
+  6616 => "SASL OPENID20",
+  7628 => "SASL OAUTH10A, OAUTHBEARER",
+  7677 => "SASL SCRAM-SHA-256, SCRAM-SHA256-PLUS",
+
+  # "Informational" RFCs
+  1733 => "Distributed E-Mail Models in IMAP4",
+  4549 => "Synchronization Operations for Disconnected IMAP4 Clients",
+
+  # TLS and other security concerns
+  2595 => "Using TLS with IMAP, POP3 and ACAP",
+  6151 => "Updated Security Considerations for MD5 Message-Digest and HMAC-MD5",
+  7525 => "Recommendations for Secure Use of TLS and DTLS",
+  7818 => "Updated TLS Server Identity Check Procedure for Email Protocols",
+  8314 => "Cleartext Considered Obsolete: Use of TLS for Email",
+  8996 => "Deprecating TLS 1.0 and TLS 1.1,",
+
+  # related email specifications
+  6376 => "DomainKeys Identified Mail (DKIM) Signatures",
+  6409 => "Message Submission for Mail",
+
+  # Other IMAP4 "Standards Track" RFCs
+  5092 => "IMAP URL Scheme",
+  5593 => "IMAP URL Access Identifier Extension",
+  5530 => "IMAP Response Codes",
+  6186 => "Use of SRV Records for Locating Email Submission/Access Services",
+  8305 => "Happy Eyeballs Version 2: Better Connectivity Using Concurrency",
+
+  # IMAP4 Extensions
+  2177 => "IMAP IDLE",
+  2193 => "IMAP MAILBOX-REFERRALS",
+  2221 => "IMAP LOGIN-REFERRALS",
+  2342 => "IMAP NAMESPACE",
+  2971 => "IMAP ID",
+  3502 => "IMAP MULTIAPPEND",
+  3516 => "IMAP BINARY",
+  3691 => "IMAP UNSELECT",
+  4314 => "IMAP ACL, RIGHTS=",
+  4315 => "IMAP UIDPLUS",
+  4467 => "IMAP URLAUTH",
+  4469 => "IMAP CATENATE",
+  4731 => "IMAP ESEARCH",
+  4959 => "IMAP SASL-IR",
+  4978 => "IMAP COMPRESS=DEFLATE",
+  5032 => "IMAP WITHIN",
+  5161 => "IMAP ENABLE",
+  5182 => "IMAP SEARCHRES",
+  5255 => "IMAP I18NLEVEL=1, I18NLEVEL=2, LANGUAGE",
+  5256 => "IMAP SORT, THREAD",
+  5257 => "IMAP ANNOTATE-EXPERIMENT-1",
+  5258 => "IMAP LIST-EXTENDED",
+  5259 => "IMAP CONVERT",
+  5267 => "IMAP CONTEXT=SEARCH, CONTEXT=SORT, ESORT",
+  5464 => "IMAP METADATA, METADATA-SERVER",
+  5465 => "IMAP NOTIFY",
+  5466 => "IMAP FILTERS",
+  5524 => "IMAP URLAUTH=BINARY", # see also: [RFC Errata 6214]
+  5550 => "IMAP URL-PARTIAL",
+  5738 => "IMAP UTF8=ALL, UTF8=APPEND, UTF8=USER", # OBSOLETED by RFC6855
+  5819 => "IMAP LIST-STATUS",
+  5957 => "IMAP SORT=DISPLAY",
+  6154 => "IMAP SPECIAL-USE, CREATE-SPECIAL-USE",
+  6203 => "IMAP SEARCH=FUZZY",
+  6785 => "IMAP IMAPSIEVE=",
+  6851 => "IMAP MOVE",
+  6855 => "IMAP UTF8=ACCEPT, UTF8=ONLY",
+  7162 => "IMAP CONDSTORE, QRESYNC",
+  7377 => "IMAP MULTISEARCH",
+  7888 => "IMAP LITERAL+, LITERAL-",
+  7889 => "IMAP APPENDLIMIT",
+  8437 => "IMAP UNAUTHENTICATE",
+  8438 => "IMAP STATUS=SIZE",
+  8440 => "IMAP LIST-MYRIGHTS",
+  8474 => "IMAP OBJECTID",
+  8508 => "IMAP REPLACE",
+  8514 => "IMAP SAVEDATE",
+  8970 => "IMAP PREVIEW",
+  9208 => "IMAP QUOTA, QUOTA=, QUOTASET",
+
+  # etc...
+  6857 => "Post-Delivery Message Downgrading for I18n Email Messages",
+
+}.freeze
+
+task :rfcs => RFCS.keys.map {|n| "rfcs/rfc%04d.txt" % [n] }
+
+RFC_RE = %r{rfcs/rfc(\d+).*\.txt}.freeze
+rule RFC_RE do |t|
+  require "fileutils"
+  FileUtils.mkpath "rfcs"
+  require "net/http"
+  t.name =~ RFC_RE
+  rfc_url = URI("https://www.rfc-editor.org/rfc/rfc#$1.txt")
+  rfc_txt = Net::HTTP.get(rfc_url)
+  File.write(t.name, rfc_txt)
+end
+
+CLEAN.include "rfcs/rfc*.txt"

data/rakelib/saslprep.rake

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "string_prep_tables_generator"
+
+generator = StringPrepTablesGenerator.new
+
+file generator.json_filename => generator.json_deps do |t|
+  generator.generate_json_data_file
+end
+
+directory "lib/net/imap/sasl"
+
+file "lib/net/imap/sasl/stringprep_tables.rb" => generator.rb_deps do |t|
+  File.write t.name, generator.stringprep_rb
+end
+
+file "lib/net/imap/sasl/saslprep_tables.rb" => generator.rb_deps do |t|
+  File.write t.name, generator.saslprep_rb
+end
+
+GENERATED_RUBY = FileList.new(
+  "lib/net/imap/sasl/stringprep_tables.rb",
+  "lib/net/imap/sasl/saslprep_tables.rb",
+)
+
+CLEAN.include   generator.clean_deps
+CLOBBER.include GENERATED_RUBY
+
+task saslprep_rb: GENERATED_RUBY
+task test: :saslprep_rb

data/rakelib/string_prep_tables_generator.rb

@@ -0,0 +1,423 @@
+# frozen_string_literal: true
+
+# Generator for stringprep regexps.
+#
+# Combines Unicode character classes with generated tables.  Generated regexps
+# are still used to test that the written regexps conform to the specification.
+# Some tables don't match up well with any character properties available to
+# ruby's regexp engine.  Those use the table-generated regexps.
+class StringPrepTablesGenerator
+  STRINGPREP_RFC_FILE  = "rfcs/rfc3454.txt"
+  STRINGPREP_JSON_FILE = "rfcs/rfc3454-stringprep_tables.json"
+
+  # valid UTF-8 can't contain these codepoints
+  # checking for them anyway, using /\p{Cs}/  ;)
+  SURROGATES_RANGE = 0xD800..0xDFFF
+
+  attr_reader :json_filename, :rfc_filename
+
+  def initialize(rfc_filename:  STRINGPREP_RFC_FILE,
+                 json_filename: STRINGPREP_JSON_FILE)
+    @rfc_filename  = rfc_filename
+    @json_filename = json_filename
+  end
+
+  # for rake deps
+  def json_deps;  Rake::FileList.new __FILE__, STRINGPREP_RFC_FILE  end
+  def rb_deps;    Rake::FileList.new __FILE__, STRINGPREP_JSON_FILE end
+  def clean_deps; Rake::FileList.new           STRINGPREP_JSON_FILE end
+
+  def generate_json_data_file
+    require "json"
+    rfc_filename
+      .then(&File.method(:read))
+      .then(&method(:parse_rfc_text))
+      .then(&JSON.method(:pretty_generate))
+      .then {|data| File.write json_filename, data }
+  end
+
+  def tables;  @tables  ||= load_tables_and_titles_from_json!.first end
+  def titles;  @titles  ||= load_tables_and_titles_from_json!.last end
+  def ranges;  @ranges  ||= tables.transform_values(&method(:to_ranges)) end
+  def arrays;  @arrays  ||= ranges.transform_values{|t| t.flat_map(&:to_a) } end
+  def sets;    @sets    ||= arrays.transform_values(&:to_set) end
+  def regexps; @regexps ||= arrays.transform_values(&method(:to_regexp)) end
+  def asgn_regexps; @asgn_regexps || asgn_regexps! end
+
+  def merged_tables_regex(*table_names, negate: false)
+    table_names
+      .flat_map(&arrays.method(:fetch))
+      .then {|array| to_regexp(array, negate: negate) }
+  end
+
+  def regexp_for(*names, negate: false)
+    asgn_regexps[[*names, negate]] ||= merged_tables_regex(*names, negate: negate)
+  end
+
+  def stringprep_rb
+    <<~RUBY
+      # frozen_string_literal: true
+
+      #--
+      # This file is generated from RFC3454, by rake.  Don't edit directly.
+      #++
+
+      module Net::IMAP::SASL
+
+        module StringPrep
+
+          #{asgn_table "A.1"}
+
+          #{asgn_table "B.1"}
+
+          #{asgn_table "B.2"}
+
+          #{asgn_table "B.3"}
+
+          #{asgn_table "C.1.1"}
+
+          #{asgn_table "C.1.2"}
+
+          #{asgn_table "C.2.1"}
+
+          #{asgn_table "C.2.2"}
+
+          #{asgn_table "C.3"}
+
+          #{asgn_table "C.4"}
+
+          #{asgn_table "C.5"}
+
+          #{asgn_table "C.6"}
+
+          #{asgn_table "C.7"}
+
+          #{asgn_table "C.8"}
+
+          #{asgn_table "C.9"}
+
+          #{asgn_table "D.1"}
+
+          # Used to check req3 of bidirectional checks
+          #{asgn_table "D.1", negate: true}
+
+          #{asgn_table "D.2"}
+
+          BIDI_DESC_REQ2 = "A string with RandALCat characters must not contain LCat characters."
+
+          # Bidirectional Characters [StringPrep, §6], Requirement 2::
+          #   If a string contains any RandALCat character, the string MUST NOT
+          #   contain any LCat character.
+          BIDI_FAILS_REQ2 = #{bidi_fails_req2.inspect}.freeze
+
+          BIDI_DESC_REQ3 = "A string with RandALCat characters must start and end with RandALCat characters."
+
+          # Bidirectional Characters [StringPrep, §6], Requirement 3::
+          #   If a string contains any RandALCat character, a RandALCat
+          #   character MUST be the first character of the string, and a
+          #   RandALCat character MUST be the last character of the string.
+          BIDI_FAILS_REQ3 = #{bidi_fails_req3.inspect}.freeze
+
+          # Bidirectional Characters [StringPrep, §6]
+          BIDI_FAILURE = #{bidi_failure_regexp.inspect}.freeze
+
+          # Names of each codepoint table in the RFC-3454 appendices
+          TABLE_TITLES = {
+            #{table_titles_rb}
+          }.freeze
+
+          # Regexps matching each codepoint table in the RFC-3454 appendices
+          TABLE_REGEXPS = {
+            #{table_regexps_rb}
+          }.freeze
+
+        end
+      end
+    RUBY
+  end
+
+  def table_titles_rb(indent = 3)
+    titles
+      .map{|t| "%p => %p," % t }
+      .join("\n#{"  "*indent}")
+  end
+
+  def table_regexps_rb(indent = 3)
+    asgn_regexps # => { ["A.1", false] => regexp, ... }
+      .reject {|(_, n), _| n }
+      .map {|(t, _), _| "%p => %s," % [t, regexp_const_name(t)] }
+      .join("\n#{"  "*indent}")
+  end
+
+  def saslprep_rb
+    <<~RUBY
+      # frozen_string_literal: true
+
+      #--
+      # This file is generated from RFC3454, by rake.  Don't edit directly.
+      #++
+
+      module Net::IMAP::SASL
+
+        module SASLprep
+
+          # RFC4013 §2.1 Mapping - mapped to space
+          # * non-ASCII space characters (\\StringPrep\\[\\"C.1.2\\"]) that can be
+          #   mapped to SPACE (U+0020), and
+          #
+          # Equal to \\StringPrep\\[\\"C.1.2\\"].
+          # Redefined here to avoid loading the StringPrep module.
+          MAP_TO_SPACE = #{regex_str "C.1.2"}
+
+          # RFC4013 §2.1 Mapping - mapped to nothing
+          #   the "commonly mapped to nothing" characters (\\StringPrep\\[\\"B.1\\"])
+          #   that can be mapped to nothing.
+          #
+          # Equal to \\StringPrep\\[\\"B.1\\"].
+          # Redefined here to avoid loading the StringPrep module.
+          MAP_TO_NOTHING = #{regex_str "B.1"}
+
+          # RFC4013 §2.3 Prohibited Output::
+          # * Non-ASCII space characters — \\StringPrep\\[\\"C.1.2\\"]
+          # * ASCII control characters — \\StringPrep\\[\\"C.2.1\\"]
+          # * Non-ASCII control characters — \\StringPrep\\[\\"C.2.2\\"]
+          # * Private Use characters — \\StringPrep\\[\\"C.3\\"]
+          # * Non-character code points — \\StringPrep\\[\\"C.4\\"]
+          # * Surrogate code points — \\StringPrep\\[\\"C.5\\"]
+          # * Inappropriate for plain text characters — \\StringPrep\\[\\"C.6\\"]
+          # * Inappropriate for canonical representation characters — \\StringPrep\\[\\"C.7\\"]
+          # * Change display properties or deprecated characters — \\StringPrep\\[\\"C.8\\"]
+          # * Tagging characters — \\StringPrep\\[\\"C.9\\"]
+          TABLES_PROHIBITED = #{SASL_TABLES_PROHIBITED.inspect}.freeze
+
+          # Adds unassigned (by Unicode 3.2) codepoints to TABLES_PROHIBITED.
+          #
+          # RFC4013 §2.5 Unassigned Code Points::
+          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its list of
+          #   unassigned code points.
+          TABLES_PROHIBITED_STORED = ["A.1", *TABLES_PROHIBITED].freeze
+
+          # Matches codepoints prohibited by RFC4013 §2.3.
+          #
+          # See TABLES_PROHIBITED.
+          #
+          # Equal to +Regexp.union+ of the TABLES_PROHIBITED tables.  Redefined
+          # here to avoid loading the StringPrep module unless necessary.
+          PROHIBITED_OUTPUT = #{regex_str(*SASL_TABLES_PROHIBITED)}
+
+          # RFC4013 §2.5 Unassigned Code Points::
+          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its list of
+          #   unassigned code points.
+          UNASSIGNED = #{regex_str "A.1"}
+
+          # Matches codepoints prohibited by RFC4013 §2.3 and §2.5.
+          #
+          # See TABLES_PROHIBITED_STORED.
+          PROHIBITED_OUTPUT_STORED = Regexp.union(
+            UNASSIGNED, PROHIBITED_OUTPUT
+          ).freeze
+
+          # Bidirectional Characters [StringPrep, §6]
+          BIDI_FAILURE = #{bidi_failure_regexp.inspect}.freeze
+
+          # Matches strings prohibited by RFC4013 §2.3 and §2.4.
+          #
+          # This checks prohibited output and bidirectional characters.
+          PROHIBITED = Regexp.union(
+            PROHIBITED_OUTPUT, BIDI_FAILURE,
+          )
+
+          # Matches strings prohibited by RFC4013 §2.3, §2.4, and §2.5.
+          #
+          # This checks prohibited output, bidirectional characters, and
+          # unassigned codepoints.
+          PROHIBITED_STORED = Regexp.union(
+            PROHIBITED_OUTPUT_STORED, BIDI_FAILURE,
+          )
+
+        end
+      end
+    RUBY
+  end
+
+  private
+
+  def parse_rfc_text(rfc3454_text)
+    titles = {}
+    tables, = rfc3454_text
+      .lines
+      .each_with_object([]) {|line, acc|
+        current, table = acc.last
+        case line
+        when /^([A-D]\.[1-9](?:\.[1-9])?) (.*)/
+          titles[$1] = $2
+        when /^ {3}-{5} Start Table (\S*)/
+          acc << [$1, []]
+        when /^ {3}-{5} End Table /
+          acc << [nil, nil]
+        when /^ {3}([0-9A-F]+); ([ 0-9A-F]*)(?:;[^;]*)$/  # mapping tables
+          table << [$1, $2.split(/ +/)] if current
+        when /^ {3}([-0-9A-F]+)(?:;[^;]*)?$/              # regular tables
+          table << $1 if current
+        when /^ {3}(.*)/
+          raise "expected to match %p" % $1 if current
+        end
+      }
+      .to_h.compact
+      .transform_values {|t| t.first.size == 2 ? t.to_h : t }
+    tables["titles"] = titles
+    tables
+  end
+
+  def load_tables_and_titles_from_json!
+    require "json"
+    @tables = json_filename
+      .then(&File.method(:read))
+      .then(&JSON.method(:parse))
+    @titles = @tables.delete "titles"
+    [@tables, @titles]
+  end
+
+  def to_ranges(table)
+    (table.is_a?(Hash) ? table.keys : table)
+      .map{|range| range.split(?-).map{|cp| Integer cp, 16} }
+      .map{|s,e| s..(e || s)}
+  end
+
+  # Starting from a codepoints array (rather than ranges) to deduplicate merged
+  # tables.
+  def to_regexp(codepoints, negate: false)
+    codepoints
+      .grep_v(SURROGATES_RANGE) # remove surrogate codepoints from C.5 and D.2
+      .uniq
+      .sort
+      .chunk_while {|cp1,cp2| cp1 + 1 == cp2 }     # find contiguous chunks
+      .map {|chunk| chunk.map{|cp| "%04x" % cp } } # convert to hex strings
+      .partition {|chunk| chunk[1] }               # ranges vs singles
+      .then {|ranges, singles|
+        singles.flatten!
+        [
+          negate ? "^" : "",
+          singles.flatten.any? ? "\\u{%s}" % singles.join(" ") : "",
+          ranges.map {|r| "\\u{%s}-\\u{%s}" % [r.first, r.last] }.join,
+          codepoints.any?(SURROGATES_RANGE) ? "\\p{Cs}" : "", # not necessary :)
+        ].join
+      }
+      .then {|char_class| Regexp.new "[#{char_class}]" }
+  end
+
+  def asgn_regexps!
+    @asgn_regexps = {}
+    # preset the regexp for each table
+    asgn_regex "A.1", /\p{^AGE=3.2}/
+    # If ruby supported all unicode properties (i.e. line break = word joiner):
+    #   /[\u{00ad 034f 1806}\p{join_c}\p{VS}\p{lb=WJ}&&\p{age=3.2}]/
+    asgn_table "B.1"
+    asgn_table "B.2"
+    asgn_table "B.3"
+    asgn_regex "C.1.1", / /
+    asgn_regex "C.1.2", /[\u200b\p{Zs}&&[^ ]]/
+    asgn_regex "C.2.1", /[\x00-\x1f\x7f]/
+    # C.2.2 is a union:
+    #   Cc + Cf (as defined by Unicode 3.2) + Zl + Zp + 0xfffc
+    #   - any codepoints covered by C.2.1 or C.8 or C.9
+    #
+    # But modern Unicode properties are significantly different, so it's better
+    # to just load the table definition.
+    asgn_table "C.2.2"
+    asgn_regex "C.3", /\p{private use}/
+    asgn_regex "C.4", /\p{noncharacter code point}/
+    asgn_regex "C.5", /\p{surrogate}/
+    asgn_regex "C.6", /[\p{in specials}&&\p{AGE=3.2}&&\p{^NChar}]/
+    asgn_regex "C.7", /[\p{in ideographic description characters}&&\p{AGE=3.2}]/
+    # C.8 is a union of \p{Bidi Control} and Unicode 3.2 properties.  But those properties
+    # have changed for modern Unicode, and thus for modern ruby's regexp
+    # character properties.  It's better to just load the table definition.
+    asgn_table "C.8"
+    asgn_regex "C.9", /[\p{in Tags}&&\p{AGE=3.2}]/
+    # Unfortunately, ruby doesn't (currently) support /[\p{Bidi
+    # Class=R}\p{bc=AL}]/.  On the other hand, StringPrep (based on Unicode 3.2)
+    # might not be a good match for the modern (14.0) property value anyway.
+    asgn_table "D.1"
+    asgn_table "D.1", negate: true # used by BIDI_FAILS_REQ3
+    asgn_table "D.2"
+    @asgn_regexps
+  end
+
+  def regex_str(*names, negate: false)
+    "%p.freeze" % regexp_for(*names, negate: negate)
+  end
+
+  def asgn_table(name, negate: false)
+    asgn_regex(name, regexp_for(name, negate: negate), negate: negate)
+  end
+
+  def regexp_const_desc(name, negate: false)
+    if negate then "Matches the negation of the %s table" % [name]
+    else %q{%s \\StringPrep\\[\\"%s\\"]} % [titles.fetch(name), name]
+    end
+  end
+
+  def regexp_const_name(table_name, negate: false)
+    "IN_%s%s" % [table_name.tr(".", "_"), negate ? "_NEGATED" : ""]
+  end
+
+  def asgn_regex(name, regexp, negate: false)
+    asgn_regexps[[name, negate]] = regexp
+    "# %s\n%s%s = %p.freeze" % [
+      regexp_const_desc(name, negate: negate), " " * 4,
+      regexp_const_name(name, negate: negate),
+      regexp,
+    ]
+  end
+
+  def bidi_R_AL     ; regexp_for "D.1" end
+  def bidi_not_R_AL ; regexp_for "D.1", negate: true end
+  def bidi_L        ; regexp_for "D.2" end
+
+  def bidi_fails_req2
+    / # RandALCat followed by LCat
+      (?<r_and_al_cat>#{bidi_R_AL.source})
+        .*?
+        (?<l_cat>#{bidi_L.source})
+      | # RandALCat preceded by LCat
+        \g<l_cat> .*? \g<r_and_al_cat>
+    /mux
+  end
+
+  def bidi_fails_req3
+    / # contains RandALCat but doesn't start with RandALCat
+      \A(?<not_r_nor_al>#{bidi_not_R_AL})
+        .*?
+        (?<r_and_al_cat>#{bidi_R_AL})
+      | # contains RandALCat but doesn't end with RandALCat
+        \g<r_and_al_cat> .*? \g<not_r_nor_al>\z
+    /mux
+  end
+
+  # shares the bidi_R_AL definition between both req2 and req3
+  def bidi_failure_regexp
+    req3_with_backref = bidi_fails_req3.source
+      .gsub(%r{\(\?\<r_and_al_cat\>\(.*?\)\)}, "\g<r_and_al_cat>")
+      .then{|re|"(?mx-i:#{re})"}
+    /#{bidi_fails_req2} | #{req3_with_backref}/mux
+  end
+
+  def bidi_consts
+    <<~RUBY
+      #############
+          # Bidirectional checks.
+          #
+
+    RUBY
+  end
+
+  SASL_TABLES_PROHIBITED = %w[
+    C.1.2 C.2.1 C.2.2 C.3 C.4 C.5 C.6 C.7 C.8 C.9
+  ].freeze
+
+  SASL_TABLES_PROHIBITED_STORED = %w[
+    A.1 C.1.2 C.2.1 C.2.2 C.3 C.4 C.5 C.6 C.7 C.8 C.9
+  ].freeze
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Shugo Maeda
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: date
+  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: digest
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +82,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/stringprep.yml
+- benchmarks/table-regexps.yml
+- docs/styles.css
 - lib/net/imap.rb
 - lib/net/imap/authenticators.rb
 - lib/net/imap/authenticators/cram_md5.rb
@@ -81,7 +98,16 @@ files:
 - lib/net/imap/flags.rb
 - lib/net/imap/response_data.rb
 - lib/net/imap/response_parser.rb
+- lib/net/imap/sasl.rb
+- lib/net/imap/sasl/saslprep.rb
+- lib/net/imap/sasl/saslprep_tables.rb
+- lib/net/imap/sasl/stringprep.rb
+- lib/net/imap/sasl/stringprep_tables.rb
 - net-imap.gemspec
+- rakelib/rdoc.rake
+- rakelib/rfcs.rake
+- rakelib/saslprep.rake
+- rakelib/string_prep_tables_generator.rb
 homepage: https://github.com/ruby/net-imap
 licenses:
 - Ruby