aaf-mdqt 0.8.6 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3607723ca50d0ad9b5260a6237a170b0dc3a09ece0453614842714ad5e45a72
-  data.tar.gz: 2c4516efca0ee0c52961a0c28c5e5673dcc0103bcc21036eb45a36f5b8a76538
+  metadata.gz: e7f884d01697f865d55c804cdcdc6effe83d1f80023de88cd5e557d395a34aba
+  data.tar.gz: a6bc73de15949019ccfae61edb365bd4633db5f77f1c7729126f35ff4fae982a
 SHA512:
-  metadata.gz: 5942b39c2069d96f172ae8d2c4578456eb186d581ae9cc2fef9539b9e2de04b7d9e2101c45032b2454b09c4e373b25e5ab10f51b8a82918a4f4c4268fd9f9427
-  data.tar.gz: d67e898ace8c98bbab2a194e7161167ed63b0a23d8ac447d9c872345816b797d3877b461dafab0cde56b77a33c5dc0f6edea7b32d64cec5a48a39e529d5c3399
+  metadata.gz: f2dd7c004d066083182426d878b421611713c29d847ea483787770e59bfa64c84c6ede5e15d6d8942370f76c66c9c8416126c23bb66ed65d293252370296075d
+  data.tar.gz: 7979f13e2252926ecd6a76e9921cce791ea825b13e555a91fdb3765770667efdb9b97af07794e08ff81caa8069d7ecdae2c56f0146936fd1e21a3efea0b2d285

data/README.md

@@ -1,6 +1,8 @@
+# NOTE: forked from <https://github.com/Digital-Identity-Labs/mdqt>
+
 # MDQT - A Metadata Query Tool
 
-[![Gem Version](https://badge.fury.io/rb/mdqt.svg)](https://badge.fury.io/rb/mdqt) [![Maintainability](https://api.codeclimate.com/v1/badges/111c46aaebfe25e4a4a9/maintainability)](https://codeclimate.com/github/Digital-Identity-Labs/mdqt/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/111c46aaebfe25e4a4a9/test_coverage)](https://codeclimate.com/github/Digital-Identity-Labs/mdqt/test_coverage) [![Build Status](https://travis-ci.org/Digital-Identity-Labs/mdqt.svg?branch=master)](https://travis-ci.org/Digital-Identity-Labs/mdqt)
+[![Gem Version](https://badge.fury.io/rb/aaf-mdqt.svg)](https://badge.fury.io/rb/aaf-mdqt)
 
 MDQT is small library and commandline tool to query MDQ services for SAML metadata.
 You could do this with `curl` and `xmlsec1` but it's a little more convenient to use `mdqt` instead.
@@ -9,17 +11,16 @@ MDQT also has features for managing local metadata files, to help when running a
 
 MDQ currently provides these features:
 
-  - Downloading single entities, lists or aggregates
-  - Signature verification
-  - Validating metadata against SAML2 schema
-  - Saving metadata to disk
-  - Extracting entity IDs from both aggregate and individual metadata files
-  - Renaming metadata files to their entity ID sha1 hashes (for use with LocalDynamicMetadataProvider)
-  - Creating sha1 hash symlinks to metadata files (also for use with Local Dynamic Metadata)
-  - Listing the entity IDs of downloaded metadata files
-  - Showing the full URL of an entity
-  - Caching entity metadata and using Gzip compression
-
+- Downloading single entities, lists or aggregates
+- Signature verification
+- Validating metadata against SAML2 schema
+- Saving metadata to disk
+- Extracting entity IDs from both aggregate and individual metadata files
+- Renaming metadata files to their entity ID sha1 hashes (for use with LocalDynamicMetadataProvider)
+- Creating sha1 hash symlinks to metadata files (also for use with Local Dynamic Metadata)
+- Listing the entity IDs of downloaded metadata files
+- Showing the full URL of an entity
+- Caching entity metadata and using Gzip compression
 
 ## MDQ?
 
@@ -39,11 +40,11 @@ MDQT is tested on recent MacOS and Linux, and should work with
 
 To install system-wide on your default Ruby, use
 
-    $ sudo gem install mdqt
+    sudo gem install mdqt
 
 If using a per-user Ruby via `rbenv`, `asdf` or similar, you'll need
 
-    $ gem install mdqt
+    gem install mdqt
 
 ### As part of a Ruby project
 
@@ -55,7 +56,7 @@ gem 'mdqt'
 
 and then execute:
 
-    $ bundle
+    bundle
 
 ### As a Docker container
 
@@ -71,39 +72,39 @@ signature. Some MDQ services use unencrypted HTTP connections and rely
 MDQT supports signature verification but requires a Ruby library called
 Nokogiri to do the hard work. Nokogiri is fast and useful but can sometimes
 be awkward to install for non-developers (it can sometimes require a C development
-environment and various XML libraries). In most cases Nokogiri will install 
-automatically, without problems, when you install MDQT, but if you encounter any 
+environment and various XML libraries). In most cases Nokogiri will install
+automatically, without problems, when you install MDQT, but if you encounter any
 problems installing Nokogiri the [Installing Nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) documentation is very helpful.
 
 ## Commandline Usage as an MDQ client
 
 You can see a list of commandline options by typing:
 
-    $ mdqt help
+    mdqt help
 
 To see more information about a command, use the `--help` option after the command or type `help <command>`:
 
-    $ mdqt help get
+    mdqt help get
 
 ### Selecting an MDQ service to access
 
 You can specify the MDQ service with a commandline option:
 
-    $ mdqt get --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
+    mdqt get --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
 
 It's more convenient to set an environment variable to specify a default MDQ
 service. Set `MDQT_SERVICE` or `MDQ_BASE_URL` to the base URL of your MDQ service.
 
-    $ export MDQT_SERVICE=https://mdq.example.com/mdq
-    $ mdqt get http://entity.ac.uk/shibboleth
-    $ mdqt get http://example.org/service
+    export MDQT_SERVICE=https://mdq.example.com/mdq
+    mdqt get http://entity.ac.uk/shibboleth
+    mdqt get http://example.org/service
 
 Finally, if you don't specify an MDQ service with `--service` or `MDQT_SERVICE` then `mdqt` *might* be
 able to guess your local NREN's MDQ service. Do not do this in production!
 
 If an MDQ service is known to MDQT it can be selected using an alias:
 
-    $ mdqt get --service incommon  http://entity.edu/shibboleth
+    mdqt get --service incommon  http://entity.edu/shibboleth
 
 You can see known services and their aliases using `mdqt services`
 
@@ -111,20 +112,19 @@ You can see known services and their aliases using `mdqt services`
 
 Downloading entity metadata to STDOUT:
 
-    $ mdqt get https://test-idp.ukfederation.org.uk/idp/shibboleth
+    mdqt get https://test-idp.ukfederation.org.uk/idp/shibboleth
 
 Using the sha1 hashed version of entity IDs requires quotes or escaping in some shells:
 
-    $ mdqt get "{sha1}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9"
+    mdqt get "{sha1}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9"
 
-    $ mdqt get \{sha1\}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9
+    mdqt get \{sha1\}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9
 
-    $ mdqt get [sha1]52e2065fc0d53744e8d4ee2c2f30696ebfc5def9
+    mdqt get [sha1]52e2065fc0d53744e8d4ee2c2f30696ebfc5def9
 
 Requesting all metadata from an MDQ endpoint is done by specifying `--all`:
 
-    $ mdqt get --all
-
+    mdqt get --all
 
 ### Caching metadata
 
@@ -132,16 +132,15 @@ Caching can be enabled using `--cache`. At the moment the `mdqt` executable
 only supports caching to disk. It will create a cache directory in your temporary
 directory.
 
-    $ mdqt get --cache --service https://mdq.example.com/mdq http://entity.ac.uk/shibboleth
+    mdqt get --cache --service https://mdq.example.com/mdq http://entity.ac.uk/shibboleth
 
 Caching is now on by default. To force a single command to *not* use the cache, include `--reset`
 
-    $ mdqt get --reset --service https://mdq.example.com/mdq http://entity.ac.uk/shibboleth
+    mdqt get --reset --service https://mdq.example.com/mdq http://entity.ac.uk/shibboleth
 
 You can clear the cache by using the `reset` command:
 
-    $ mdqt reset
-
+    mdqt reset
 
 ### Verifying metadata
 
@@ -149,22 +148,22 @@ If you have enabled verification by installing `xmldsig` (and have downloaded an
 certificate for your MDQ server) you can require verification by passing
 they `verify-with` flag with the path of your certificate.
 
-    $ mdqt get --verify-with myfederation.pem https://indiid.net/idp/shibboleth
+    mdqt get --verify-with myfederation.pem https://indiid.net/idp/shibboleth
 
 It's possible to pass more than one certificate by separating them with commas
 
-    $ mdqt get --verify-with myfederation.pem,previous.pem https://indiid.net/idp/shibboleth
+    mdqt get --verify-with myfederation.pem,previous.pem https://indiid.net/idp/shibboleth
 
 Basic XML correctness and validation against SAML2 Metadata schema can be enabled with the
 `--validate` switch:
 
-    $ mdqt get --validate https://indiid.net/idp/shibboleth
+    mdqt get --validate https://indiid.net/idp/shibboleth
 
 If you need to check metadata that has already been downloaded then try the `check`
 command:
 
-    $ mdqt check metadata.xml # Just validate
-    $ mdqt check --verify-with myfederation.pem metadata.xml # Verify signature too
+    mdqt check metadata.xml # Just validate
+    mdqt check --verify-with myfederation.pem metadata.xml # Verify signature too
 
 You shouldn't need to *validate* XML from a trusted MDQ service such as one run by a
 national federation. You should however always *verify* the signature of XML sent over an unencrypyted HTTP connection,
@@ -175,11 +174,11 @@ or debugging your own MDQ service.
 
 The simplest way to save metadata is to redirect output from the `get` command:
 
-    $ mdqt get http://entity.ac.uk/shibboleth > metadata.xml
+    mdqt get http://entity.ac.uk/shibboleth > metadata.xml
 
 MDQT also offers the `--save-to` option to write all metadata into a directory
 
-    $ mdqt get http://entity.ac.uk/shibboleth --save-to metadata_directory
+    mdqt get http://entity.ac.uk/shibboleth --save-to metadata_directory
 
 The `--save-to` option requires a directory to be specified. All files will be saved
 with a name based on their transformed identifier (sha1 hash) such as
@@ -194,55 +193,55 @@ For more information about current settings, download results, and so on, add
 
 To convert normal URI entity IDs into MDQ SHA1 hashed transformed identifiers use the `transform` command:
 
-    $ mdqt transform http://example.org/service
+    mdqt transform http://example.org/service
 
 Transforming identifiers that have already been transformed should not re-transform them.
 
 To see more details of what is being sent and received by a `get` command add the `--explain` flag
 
-    $ mdqt get --explain --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
+    mdqt get --explain --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
 
 MDQT will then show a table of sent and received headers which may be useful when debugging servers.
 
 To extract a list of all entity IDs from a file:
 
-    $ mdqt entities metadata.xml
+    mdqt entities metadata.xml
 
-    $ mdqt entities --sha1 metadata.xml
+    mdqt entities --sha1 metadata.xml
 
 To create sha1 symlinks to a metadata file:
 
-    $ mdqt ln example_idp.xml
+    mdqt ln example_idp.xml
 
 To rename a file to its entity ID sha1 has:
 
-    $ mdqt rename example_idp.xml
+    mdqt rename example_idp.xml
 
 To list the entity IDs of files in a directory:
 
-    $ mdqt ls
+    mdqt ls
 
 To list all entities available at an MDQ service:
 
-    $ mdqt list
+    mdqt list
 
 To show the MDQ services known to MDQT, and their aliases:
 
-    $ mdqt services
+    mdqt services
 
 To show the full MDQ URL of an entity
 
-    $ mdqt url http://entity.ac.uk/shibboleth
+    mdqt url http://entity.ac.uk/shibboleth
 
 MDQT can accept input on stdin, allowing composition and pipelining
 
-    $ cat list_of_ids.txt | mdqt url
+    cat list_of_ids.txt | mdqt url
 
-    $ mdqt list | grep cern.ch | mdqt get --save-to cern_metadata/ --list  | mdqt ls
+    mdqt list | grep cern.ch | mdqt get --save-to cern_metadata/ --list  | mdqt ls
 
 ## Alternatives
 
-  * [SAML Library](https://github.com/trscavo/saml-library) is a set of scripts to help with metadata-related tasks, written
+- [SAML Library](https://github.com/trscavo/saml-library) is a set of scripts to help with metadata-related tasks, written
 by Tom Scavo of Internet2. Some of the scripts provide similar functionality to MDQT, and are designed to be piped together.
 
 ## Library Usage
@@ -260,7 +259,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Digital-Identity-Labs/mdqt.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/Digital-Identity-Labs/mdqt>.
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License

data/aaf-mdqt.gemspec

@@ -23,17 +23,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'commander', "~>4.6"
-  spec.add_dependency 'faraday', "~>2.9.0"
-  spec.add_dependency 'faraday-http-cache', "~>2.5.0"
-  spec.add_dependency 'faraday-follow_redirects', "~>0.3.0"
-  spec.add_dependency 'httpx', "~>1.2.0"
+  spec.add_dependency 'commander', "~>4"
+  spec.add_dependency 'faraday', "~>2"
+  spec.add_dependency 'faraday-http-cache', "~>2"
+  spec.add_dependency 'faraday-follow_redirects', "~>0.3"
+  spec.add_dependency 'httpx', "~>1"
   spec.add_dependency 'activesupport', "~>7"
-  spec.add_dependency 'dalli', "~>3.2"
+  spec.add_dependency 'dalli', "~>3"
   spec.add_dependency 'pastel', "~>0.8"
-  spec.add_dependency 'terminal-table', "~>3.0"
+  spec.add_dependency 'terminal-table', "~>3"
   spec.add_dependency 'concurrent-ruby-ext', "~>1"
-  spec.add_dependency 'xmldsig', "~>0.7.0"
+  spec.add_dependency 'xmldsig', "~>0.7"
 
   #  spec.add_development_dependency "bundler", "~>2"
   # spec.add_development_dependency "rake", ">= 13.1.0"

data/lib/mdqt/cli/options.rb

@@ -0,0 +1,41 @@
+module MDQT
+  class CLI
+    require 'mdqt/cli/base'
+
+    Options =
+      Struct.new(
+        :service,
+        :hash,
+        :cache,
+        :refresh,
+        :verify_with,
+        :validate,
+        :all,
+        :explain,
+        :tls_risky,
+        :save_to,
+        :list,
+        :verbose
+      ) do
+        def initialize(**args)
+          options = {
+            service: :not_required,
+            hash: nil,
+            cache: nil,
+            refresh: nil,
+            verify_with: nil,
+            validate: nil,
+            all: nil,
+            explain: nil,
+            tls_risky: nil,
+            save_to: nil,
+            list: nil,
+            verbose: nil,
+            **MDQT::CLI::Defaults.cli_defaults
+          }
+          super(**options, **args)
+        end
+      end
+  end
+end
+

data/lib/mdqt/version.rb

@@ -1,3 +1,3 @@
 module MDQT
-  VERSION = "0.8.6"
+  VERSION = "0.8.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aaf-mdqt
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.8
 platform: ruby
 authors:
 - Pete Birkinshaw
@@ -17,70 +17,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby-ext
   requirement: !ruby/object:Gem::Requirement
@@ -157,14 +157,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +242,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -276,6 +275,7 @@ files:
 - lib/mdqt/cli/list.rb
 - lib/mdqt/cli/ln.rb
 - lib/mdqt/cli/ls.rb
+- lib/mdqt/cli/options.rb
 - lib/mdqt/cli/rename.rb
 - lib/mdqt/cli/reset.rb
 - lib/mdqt/cli/services.rb

data/.github/workflows/codeql-analysis.yml

@@ -1,70 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '17 4 * * 0'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1