dmarcator 0.1.0

data/lib/dmarcator/record.rb

@@ -0,0 +1,393 @@
+require 'dmarcator/query'
+require 'dmarcator/parser'
+require 'dmarcator/exceptions'
+
+require 'resolv'
+require 'uri'
+
+module DMARCator
+  class Record
+
+    # `p` field.
+    # 
+    # @return [:none, :quarantine, :reject]
+    attr_reader :p
+
+    # `rua` field.
+    #
+    # @return [Array<Uri>]
+    attr_reader :rua
+
+    # `rua` field.
+    #
+    # @return [Array<Uri>]
+    attr_reader :ruf
+
+    # `sp` field.
+    # 
+    # @return [:none, :quarantine, :reject]
+    attr_reader :sp
+
+    # `v` field.
+    #
+    # @return [:DMARC1]
+    attr_reader :v
+
+    #
+    # Initializes the record.
+    #
+    # @param [Hash{Symbol => Object}] attributes
+    #   Attributes for the record.
+    #
+    # @option attributes [:r, :s] :adkim (:r)
+    #
+    # @option attributes [:r, :s] :aspf (:r)
+    #
+    # @option attributes [Array<'0', '1', 'd', 's'>] :fo ('0')
+    #
+    # @option attributes [:none, :quarantine, :reject] :p
+    #
+    # @option attributes [Integer] :pct (100)
+    #
+    # @option attributes [:afrf, :iodef] :rf (:afrf)
+    #
+    # @option attributes [Integer] :ri (86400)
+    #
+    # @option attributes [Array<Uri>] :rua
+    #
+    # @option attributes [Array<Uri>] :ruf
+    #
+    # @option attributes [:none, :quarantine, :reject] :sp
+    #
+    # @option attributes [:DMARC1] :v
+    #
+    def initialize(attributes={})
+      @v     = attributes.fetch(:v)
+      @adkim = attributes[:adkim]
+      @aspf  = attributes[:aspf]
+      @fo    = attributes[:fo]
+      @p     = attributes[:p]
+      @pct   = attributes[:pct]
+      @rf    = attributes[:rf]
+      @ri    = attributes[:ri]
+      @rua   = attributes[:rua]
+      @ruf   = attributes[:ruf]
+      @sp    = attributes[:sp]
+    end
+
+    #
+    # Determines if the `sp=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def sp?
+      !@sp.nil?
+    end
+
+    #
+    # The `sp=` field.
+    #
+    # @return [:none, :quarantine, :reject]
+    #   The value of the `sp=` field, or that of {#p} if the field was omitted.
+    #
+    def sp
+      @sp || @p
+    end
+
+    #
+    # Determines whether the `adkim=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def adkim?
+      !@adkim.nil?
+    end
+
+    #
+    # `adkim=` field.
+    #
+    # @return [:r, :s]
+    #   The value of the `adkim=` field, or `:r` if the field was omitted.
+    #
+    def adkim
+      @adkim || :r
+    end
+
+    #
+    # Determines whether the `aspf=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def aspf?
+      !@aspf.nil?
+    end
+
+    #
+    # `aspf` field.
+    #
+    # @return [:r, :s]
+    #   The value of the `aspf=` field, or `:r` if the field was omitted.
+    #
+    def aspf
+      @aspf || :r
+    end
+
+    #
+    # Determines whether the `fo=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def fo?
+      !@fo.nil?
+    end
+
+    #
+    # `fo` field.
+    #
+    # @return [Array<'0', '1', 'd', 's'>]
+    #   The value of the `fo=` field, or `["0"]` if the field was omitted.
+    #
+    def fo
+      @fo || %w[0]
+    end
+
+    #
+    # Determines if the `p=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def p?
+      !@p.nil?
+    end
+
+    #
+    # Determines whether the `pct=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def pct?
+      !@pct.nil?
+    end
+
+    #
+    # `pct` field.
+    #
+    # @return [Integer]
+    #   The value of the `pct=` field, or `100` if the field was omitted.
+    #
+    def pct
+      @pct || 100
+    end
+
+    #
+    # Determines whether the `rf=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def rf?
+      !@rf.nil?
+    end
+
+    #
+    # `rf` field.
+    # 
+    # @return [:afrf, :iodef]
+    #   The value of the `rf=` field, or `:afrf` if the field was omitted.
+    #
+    def rf
+      @rf || :afrf
+    end
+
+    #
+    # Determines whether the `ri=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def ri?
+      !@ri.nil?
+    end
+
+    #
+    # `ri` field.
+    #
+    # @return [Integer]
+    #   The value of the `ri=` field, or `86400` if the field was omitted.
+    #
+    def ri
+      @ri || 86400
+    end
+
+    #
+    # Determines if the `rua=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def rua?
+      !@rua.nil?
+    end
+
+    #
+    # Determines if the `ruf=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def ruf?
+      !@ruf.nil?
+    end
+
+    #
+    # Parses a DMARC record.
+    #
+    # @param [String] record
+    #   The raw DMARC record.
+    #
+    # @return [Record]
+    #   The parsed DMARC record.
+    #
+    # @raise [InvalidRecord]
+    #   The DMARC record could not be parsed.
+    #
+    # @since 0.3.0
+    #
+    # @api public
+    #
+    def self.parse(record)
+      attributes = Parser.parse(record)
+
+      unless attributes[:p]
+        raise InvalidRecord, "DMARC record is missing the required 'p' tag"
+      end
+
+      new(attributes)
+    rescue Parslet::ParseFailed => error
+      raise InvalidRecord.new(truncate_error_message(error.message), error.cause)
+    rescue URI::Error => error
+      raise InvalidRecord.new(truncate_error_message(error.message), error)
+    end
+
+    #
+    # @deprecated use {parse} instead.
+    #
+    def self.from_txt(rec)
+      parse(rec)
+    end
+
+    # Maximum length of error messages echoed from parsing untrusted input.
+    MAX_ERROR_MESSAGE_LENGTH = 500
+
+    #
+    # Truncates error messages to avoid echoing large amounts of untrusted
+    # input in exceptions.
+    #
+    # @param [String] message
+    #   The error message to truncate.
+    #
+    # @return [String]
+    #   The truncated error message.
+    #
+    def self.truncate_error_message(message)
+      message = message.to_s
+
+      if message.length > MAX_ERROR_MESSAGE_LENGTH
+        message[0, MAX_ERROR_MESSAGE_LENGTH] + "..."
+      else
+        message
+      end
+    end
+
+    #
+    # Queries and parses the DMARC record for a domain.
+    #
+    # @param [String] domain
+    #   The domain to query DMARC for.
+    #
+    # @param [Resolv::DNS] resolver
+    #   The resolver to use.
+    #
+    # @return [Record, nil]
+    #   The parsed DMARC record. If no DMARC record was found, `nil` will be
+    #   returned.
+    #
+    # @raise [InvalidRecord]
+    #   The DMARC record could not be parsed.
+    #
+    # @since 0.3.0
+    #
+    # @api public
+    #
+    def self.query(domain,resolver=Resolv::DNS.new)
+      if (dmarc = DMARCator.query(domain,resolver))
+        parse(dmarc)
+      end
+    end
+
+    #
+    # Converts the record to a Hash.
+    #
+    # @return [Hash{Symbol => Object}]
+    #
+    # @since 0.4.0
+    #
+    def to_h
+      hash = {}
+
+      hash[:v]     = @v     if @v
+      hash[:p]     = @p     if @p
+      hash[:sp]    = @sp    if @sp
+      hash[:rua]   = @rua   if @rua
+      hash[:ruf]   = @ruf   if @ruf
+      hash[:adkim] = @adkim if @adkim
+      hash[:aspf]  = @aspf  if @aspf
+      hash[:ri]    = @ri    if @ri
+      hash[:fo]    = @fo    if @fo
+      hash[:rf]    = @rf    if @rf
+      hash[:pct]   = @pct   if @pct
+
+      return hash
+    end
+
+    #
+    # Converts the record back to a DMARC String.
+    #
+    # @return [String]
+    #
+    def to_s
+      tags = []
+
+      tags << "v=#{@v}"               if @v
+      tags << "p=#{@p}"               if @p
+      tags << "sp=#{@sp}"             if @sp
+      tags << "rua=#{@rua.join(',')}" if @rua
+      tags << "ruf=#{@ruf.join(',')}" if @ruf
+      tags << "adkim=#{@adkim}"       if @adkim
+      tags << "aspf=#{@aspf}"         if @aspf
+      tags << "ri=#{@ri}"             if @ri
+      tags << "fo=#{@fo.join(':')}"   if @fo
+      tags << "rf=#{@rf}"             if @rf
+      tags << "pct=#{@pct}"           if @pct
+
+      return tags.join('; ')
+    end
+
+  end
+end

data/lib/dmarcator/uri.rb

@@ -0,0 +1,114 @@
+module DMARCator
+  #
+  # Represents a DMARC URI.
+  #
+  # @see https://tools.ietf.org/html/rfc7489#section-6.2
+  #
+  # @since 0.5.0
+  #
+  class Uri
+
+    # The `mailto:` URI.
+    #
+    # @return [URI::MailTo]
+    attr_reader :uri
+
+    # The optional maximum-size.
+    #
+    # @return [Integer, nil]
+    attr_reader :size
+
+    # The optional unit.
+    #
+    # @return [:k, :m, :g, :t, nil]
+    attr_reader :unit
+
+    #
+    # Initializes the DMARC URI.
+    #
+    # @param [URI::MailTo] uri
+    #   The `mailto:` URI.
+    #
+    # @param [Integer] size
+    #   The optional maximum-size.
+    #
+    # @param [:k, :m, :g, :t] unit
+    #   The optional size unit.
+    #
+    def initialize(uri,size=nil,unit=nil)
+      @uri = uri
+
+      @size = size
+      @unit = unit
+    end
+
+    #
+    # Determines if a maximum-size was set.
+    #
+    # @return [Boolean]
+    #
+    def size?
+      !@size.nil?
+    end
+
+    #
+    # Determines if a size unit was set.
+    #
+    # @return [Boolean]
+    #
+    def unit?
+      !@unit.nil?
+    end
+
+    #
+    # Determines if the DMARC URI matches the other.
+    #
+    # @param [Object] other
+    #   the other DMARC URI to compare against.
+    #
+    # @return [Boolean]
+    #
+    def ==(other)
+      (self.class == other.class) &&
+      (@uri == other.uri) &&
+      (@size == other.size) &&
+      (@unit == other.unit)
+    end
+
+    #
+    # Converts the DMARC URI back into a String.
+    #
+    # @return [String]
+    #
+    def to_s
+      str = @uri.to_s
+
+      if (@size || @unit)
+        str << "!"
+        str << "#{@size}" if @size
+        str << "#{@unit}" if @unit
+      end
+
+      return str
+    end
+
+    protected
+
+    #
+    # Pass all missing methods to {#uri}.
+    #
+    def method_missing(name,*arguments,&block)
+      @uri.send(name,*arguments,&block)
+    end
+
+    #
+    # Indicates whether a missing method can be handled by {#uri}.
+    #
+    # @return [Boolean]
+    #
+    def respond_to_missing?(name, include_private = false)
+      @uri.respond_to?(name, include_private) || super
+    end
+
+  end
+end

data/lib/dmarcator/version.rb

@@ -0,0 +1,4 @@
+module DMARCator
+  # dmarcator version
+  VERSION = '0.1.0'
+end

data/lib/dmarcator.rb

@@ -0,0 +1,5 @@
+require 'dmarcator/exceptions'
+require 'dmarcator/query'
+require 'dmarcator/record'
+require 'dmarcator/parser'
+require 'dmarcator/version'