varanus 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f457939fd1e7cb008b0a137827856048714d31a4fb2fda63ec027054ea62da58
-  data.tar.gz: 311572c2744ddfa0589282fec69f54eafd9ee1f602caf930f7d20051732c0ae4
+  metadata.gz: 271baf219a1247e588a20aba506a76e26668bad6c6ab55546f75fa697d04e3ff
+  data.tar.gz: 00c5bc35eeb4b56fdc94b18d969c7ac498ffc87a948db20fdc989fc4e90cf8d6
 SHA512:
-  metadata.gz: bc74433391a0cb8c59b8159e480b5acf5f519659216d0b2beaa83b2400bf4873db400b740c5ab2e1282870502edbc8351a13a702c498e5b4e76bc135c78b66c9
-  data.tar.gz: 11a6884e37fb4eec2c763f6ca428dd00dca6e113f3158722f5c5deed9468a09ee1496c27862cd623268a30821c4e9de365ed01033723f968825e55f9da7312ec
+  metadata.gz: 70898c1f830700b0a2865656143c452dfeae4b9846e9c1b4730c5cd359d2c4f786e167758581d2028fc2c60588480382066cecc932d03b7355accb84ff21a0c3
+  data.tar.gz: de4d6791505e36cbaa157a0004e2405b90f1067c0953a892a0efb6fc622b671744779603620b3c142413043e4063cbd411cf2629acb3256a7fccc308e8be93ee

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### Version 0.7.1 (2022-01-31)
+* Varanus::SSL#certificate_types_standard - also exclude 'Extended Validation'
+
+### Version 0.7.0 (2020-02-03)
+* Add Varanus::Domain#report
+
+### Version 0.6.0 (2020-02-01)
+* Add Varanus::SSL#report
+* Varanus::Reports (Varanus#reports) is now deprecated.
+
+### Version 0.5.1 (2021-01-28)
+* Varanus::SSL::CSR - support EC certs
+
 ### Version 0.5.0 (2021-01-26)
 * Add Varanus::Domain
 * Add Varanus::SSL#list and Varanus::SSL#info

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    varanus (0.5.0)
+    varanus (0.7.1)
       faraday
       faraday_middleware
       savon (~> 2.0)

data/lib/varanus/domain.rb

@@ -39,4 +39,8 @@ class Varanus::Domain < Varanus::RestResource
     domains.map! { |domain| info(domain['id']) }
     domains
   end
+
+  def report
+    post('report/v1/domains', {})['reports']
+  end
 end

data/lib/varanus/reports.rb

@@ -18,20 +18,19 @@ class Varanus::Reports
     @varanus = varanus
   end
 
+  # DEPRECATED: Please use Varanus::Domain#list_with_info instead.
   def domains
+    warn 'DEPRECATION WARNING: Varanus::Reports#domains is deprecated.  ' \
+         'Use Varanus::Domain#report instead'
     r = soap_call :get_domain_report, {}
     format_results r[:report_row_domains]
   end
 
-  # Return report on SSL request
-  # @param [opts] [Hash]
-  # @option opts [String, Array] :orgs Name(s) of organizations (departments) to limit
-  #   the report to.  If this is unset, results from all departments are returned.
-  # @option opts [Symbol] :status (:any) One of :any, :requested, :downloaded, :revoked,
-  #   :expired, :pending_download, :not_enrolled.    :downloaded and :pending_download
-  #   mean the cert has been enrolled/signed.
-  # @return [Array<Hash>]
+  # DEPRECATED: Please use Varanus::SSL#report instead.
   def ssl opts = {}
+    warn 'DEPRECATION WARNING: Varanus::Reports#ssl is deprecated.  ' \
+         'Use Varanus::SSL#report instead'
+
     msg = { organizationNames: nil, certificateStatus: 0 }
 
     msg[:organizationNames] = Array(opts[:orgs]).join(',') if opts.include? :orgs

data/lib/varanus/ssl/csr.rb

@@ -28,7 +28,7 @@ class Varanus::SSL::CSR
     request.add_attribute names_to_san_attribute(names)
     request.public_key = key.public_key
 
-    request.sign(key, OpenSSL::Digest::SHA256.new)
+    request.sign(key, OpenSSL::Digest.new('SHA256'))
 
     [key, Varanus::SSL::CSR.new(request)]
   end
@@ -87,6 +87,8 @@ class Varanus::SSL::CSR
       @request.public_key.n.num_bytes * 8
     when OpenSSL::PKey::DSA
       @request.public_key.p.num_bytes * 8
+    when OpenSSL::PKey::EC
+      @request.public_key.group.degree
     else
       raise "Unknown public key type: #{@request.public_key.class}"
     end

data/lib/varanus/ssl.rb

@@ -3,6 +3,23 @@
 # An connection to the SSL/TSL API.  This should not be initialized directly.  Instead,
 # use Varanus#ssl
 class Varanus::SSL < Varanus::RestResource
+  # rubocop:disable Style/MutableConstant
+  # These constants are frozen, rubocop is failing to detect the freeze.
+  # See https://github.com/rubocop-hq/rubocop/issues/4406
+  REPORT_CERT_STATUS = { any: 0, requested: 1, issued: 2, revoked: 3, expired: 4 }
+  REPORT_CERT_STATUS.default_proc = proc { |_h, k|
+    raise ArgumentError, "Unknown certificateStatus: #{k.inspect}"
+  }
+  REPORT_CERT_STATUS.freeze
+
+  REPORT_CERT_DATE_ATTR = { revocation_date: 2, expiration_date: 3, request_date: 4,
+                            issue_date: 5 }
+  REPORT_CERT_DATE_ATTR.default_proc = proc { |_h, k|
+    raise ArgumentError, "Unknown certificateDateAttribute: #{k.inspect}"
+  }
+  REPORT_CERT_DATE_ATTR.freeze
+  # rubocop:enable Style/MutableConstant
+
   # Returns the option from #certificate_types that best matches the csr.
   # @param csr [Varanus::SSL::CSR]
   # @return [Hash] The option from {#certificate_types} that best matches the csr
@@ -30,7 +47,7 @@ class Varanus::SSL < Varanus::RestResource
   # @return [Array<Hash>]
   def certificate_types_standard days = nil
     types = certificate_types.reject do |ct|
-      ct['name'] =~ /\b(?:EV|ECC|AMT|Elite)\b/
+      ct['name'] =~ /\b(?:EV|Extended Validation|ECC|AMT|Elite)\b/
     end
     types = types.select! { |t| t['terms'].include? days } unless days.nil?
 
@@ -60,10 +77,31 @@ class Varanus::SSL < Varanus::RestResource
     get("ssl/v1/#{id}")
   end
 
+  # List certs ids and serial numbers
   def list opts = {}
     get_with_size_and_position('ssl/v1', opts)
   end
 
+  # Return a report (list) of SSL certs based on the options.
+  # The report includes a full set of details about the certs, not just the id/cn/serial
+  # +opts+ can include:
+  # (all are optional)
+  # - :organizationIds - Array - ids of organization/departments to include certs for
+  # - :certificateStatus - :any, :requested, :issued, :revoked, or :expired
+  # - :certificateDateAttribute - Specifies what fields :from and/or :to refer to.
+  #                               Can be: :revocation_date, :expiration_date,
+  #                                       :request_date, or :issue_date
+  # - :from - Date - based on :certificateDateAttribute
+  # - :to - Date - based on :certificateDateAttribute
+  def report opts = { certificateStatus: :any }
+    # Default is to request any certificate status since the API call will fail if no
+    # options are passed
+    opts = { certificateStatus: :any } if opts.empty?
+    opts = _parse_report_opts(opts)
+
+    post('report/v1/ssl-certificates', opts)['reports']
+  end
+
   # Revoke an ssl cert
   # @param id [Integer] As returned by {#sign}
   # @param reason [String] Reason for revoking. Sectigo's API will return an error if it
@@ -130,4 +168,24 @@ class Varanus::SSL < Varanus::RestResource
     term ||= certificate_types.find { |ct| ct['id'] == cert_type_id }['terms'].min
     term
   end
+
+  def _parse_report_opts user_opts
+    api_opts = {}
+    user_opts.each do |key, val|
+      case key
+      when :organizationIds, :certificateRequestSource, :serialNumberFormat
+        api_opts[key] = val
+      when :from, :to
+        api_opts[key] = val.strftime('%Y-%m-%d')
+      when :certificateStatus
+        api_opts[key] = REPORT_CERT_STATUS[val]
+      when :certificateDateAttribute
+        api_opts[key] = REPORT_CERT_DATE_ATTR[val]
+      else
+        raise ArgumentError, "Unknown key: #{key.inspect}"
+      end
+    end
+
+    api_opts
+  end
 end

data/lib/varanus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Varanus
-  VERSION = '0.5.0'
+  VERSION = '0.7.1'
 end

data/lib/varanus.rb

@@ -47,8 +47,7 @@ class Varanus
     @organization ||= Organization.new(self)
   end
 
-  # Retrieve Reports instance
-  # @return [Varanus::Reports]
+  # DEPRECATED
   def reports
     @reports ||= Reports.new(self)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: varanus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Sean Dilda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler