ruby_aem 2.1.0 → 2.2.0

data/lib/ruby_aem/resources/truststore.rb

@@ -0,0 +1,138 @@
+# Copyright 2016-2017 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'openssl'
+require 'retries'
+require 'tempfile'
+require 'ruby_aem/error'
+
+module RubyAem
+  module Resources
+    # AEM class contains API calls related to managing the AEM Truststore.
+    class Truststore
+      # Initialise Truststore resource.
+      #
+      # @param client RubyAem::Client
+      # @return new RubyAem::Resources::Truststore instance
+      def initialize(client)
+        @client = client
+        @call_params = {}
+      end
+
+      # Create AEM Truststore.
+      #
+      # @param password Password for AEM Truststore
+      # @return RubyAem::Result
+      def create(password)
+        @call_params[:password] = password
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Read the content of Truststore file on filesystem
+      # and convert it to PKCS12 Truststore object.
+      #
+      # @param file_path path to Truststore file
+      def read(file_path, password)
+        truststore_raw = File.read file_path
+        OpenSSL::PKCS12.new(truststore_raw, password)
+      end
+
+      # Download the AEM Truststore to a specified directory.
+      #
+      # @param file_path the directory where the Truststore will be downloaded to
+      # @return RubyAem::Result
+      def download(
+        file_path
+      )
+        @call_params[:file_path] = file_path
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Upload a truststore PKCS12 file.
+      #
+      # @param file_path local file path to truststore PKCS12 file
+      # @param opts optional parameters:
+      # - force: if true then AEM Truststore will be overwritten if already exists
+      # @return RubyAem::Result
+      def upload(
+        file_path,
+        opts = {
+          force: true
+        }
+      )
+        @call_params[:file_path] = file_path
+        @call_params = @call_params.merge(opts)
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Delete AEM Truststore.
+      #
+      # @return RubyAem::Result
+      def delete
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Check if AEM Truststore exists.
+      #
+      # @return RubyAem::Result
+      def exists
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Retrieve AEM Truststore info.
+      #
+      # @return RubyAem::Result
+      def info
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Upload AEM Truststore and wait until the certificate is uploaded.
+      #
+      # @param file_path local file path to truststore PKCS12 file
+      # @param opts optional parameters:
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
+      # @return RubyAem::Result
+      def upload_wait_until_ready(
+        file_path,
+        opts = {
+          force: true,
+          _retries: {
+            max_tries: 30,
+            base_sleep_seconds: 2,
+            max_sleep_seconds: 2
+          }
+        }
+      )
+        opts[:_retries] ||= {}
+        opts[:_retries][:max_tries] ||= 30
+        opts[:_retries][:base_sleep_seconds] ||= 2
+        opts[:_retries][:max_sleep_seconds] ||= 2
+
+        # ensure integer retries setting (Puppet 3 passes numeric string)
+        opts[:_retries][:max_tries] = opts[:_retries][:max_tries].to_i
+        opts[:_retries][:base_sleep_seconds] = opts[:_retries][:base_sleep_seconds].to_i
+        opts[:_retries][:max_sleep_seconds] = opts[:_retries][:max_sleep_seconds].to_i
+
+        result = upload(file_path, force: opts[:force])
+
+        with_retries(max_tries: opts[:_retries][:max_tries], base_sleep_seconds: opts[:_retries][:base_sleep_seconds], max_sleep_seconds: opts[:_retries][:max_sleep_seconds]) { |retries_count|
+          check_result = exists
+          puts format('Upload check #%<retries_count>d: %<check_result_data>s - %<check_result_message>s', retries_count: retries_count, check_result_data: check_result.data, check_result_message: check_result.message)
+          raise StandardError.new(check_result.message) if check_result.data == false
+        }
+        result
+      end
+    end
+  end
+end

data/lib/ruby_aem/swagger.rb

@@ -67,6 +67,8 @@ module RubyAem
         'AEM Password Reset Activator'
       when 'com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck'
         'AEM Health Check Servlet'
+      when 'com.adobe.granite.auth.saml.SamlAuthenticationHandler.config'
+        'Adobe Granite SAML Authentication Handler'
       end
     end
   end

data/lib/ruby_aem.rb

@@ -14,7 +14,10 @@
 
 require 'ruby_aem/client'
 require 'ruby_aem/resources/aem'
+require 'ruby_aem/resources/authorizable_keystore'
 require 'ruby_aem/resources/bundle'
+require 'ruby_aem/resources/certificate'
+require 'ruby_aem/resources/certificate_chain'
 require 'ruby_aem/resources/config_property'
 require 'ruby_aem/resources/flush_agent'
 require 'ruby_aem/resources/group'
@@ -24,7 +27,9 @@ require 'ruby_aem/resources/path'
 require 'ruby_aem/resources/replication_agent'
 require 'ruby_aem/resources/outbox_replication_agent'
 require 'ruby_aem/resources/reverse_replication_agent'
+require 'ruby_aem/resources/saml'
 require 'ruby_aem/resources/repository'
+require 'ruby_aem/resources/truststore'
 require 'ruby_aem/resources/user'
 require 'swagger_aem'
 require 'yaml'
@@ -104,6 +109,24 @@ module RubyAem
       RubyAem::Resources::Bundle.new(@client, name)
     end
 
+    # Create a certificate instance.
+    #
+    # @param serial_number the certificate's serial number
+    # @return new RubyAem::Resources::Certificate instance
+    def certificate(serial_number)
+      RubyAem::Resources::Certificate.new(@client, serial_number)
+    end
+
+    # # Create a certificate chain instance.
+    # #
+    # @param private_key_alias Alias of the private key associated to this certificate chain
+    # @param keystore_intermediate_path AEM User home path
+    # @param keystore_authorizable_id AEM User id
+    # # @return new RubyAem::Resources::CertificateChain instance
+    def certificate_chain(private_key_alias, keystore_intermediate_path, keystore_authorizable_id)
+      RubyAem::Resources::CertificateChain.new(@client, private_key_alias, keystore_intermediate_path, keystore_authorizable_id)
+    end
+
     # Create a config property instance.
     #
     # @param name the property's name
@@ -132,6 +155,13 @@ module RubyAem
       RubyAem::Resources::Group.new(@client, path, name)
     end
 
+    # Create a Keystore instance for given authorizable id.
+    #
+    # @return new RubyAem::Resources::AuhtorizableKeystore instance
+    def authorizable_keystore(intermediate_path, authorizable_id)
+      RubyAem::Resources::AuthorizableKeystore.new(@client, intermediate_path, authorizable_id)
+    end
+
     # Create a node instance.
     #
     # @param path the path to the node, e.g. /apps/system/
@@ -193,6 +223,20 @@ module RubyAem
       RubyAem::Resources::Repository.new(@client)
     end
 
+    # Create a Saml instance.
+    #
+    # @return new RubyAem::Resources::Saml instance
+    def saml
+      RubyAem::Resources::Saml.new(@client)
+    end
+
+    # Create a Truststore instance.
+    #
+    # @return new RubyAem::Resources::Truststore instance
+    def truststore
+      RubyAem::Resources::Truststore.new(@client)
+    end
+
     # Create a user instance.
     #
     # @param path the path to user node, e.g. /home/users/s/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Shine Solutions
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,10 @@ files:
 - lib/ruby_aem/handlers/simple.rb
 - lib/ruby_aem/handlers/xml.rb
 - lib/ruby_aem/resources/aem.rb
+- lib/ruby_aem/resources/authorizable_keystore.rb
 - lib/ruby_aem/resources/bundle.rb
+- lib/ruby_aem/resources/certificate.rb
+- lib/ruby_aem/resources/certificate_chain.rb
 - lib/ruby_aem/resources/config_property.rb
 - lib/ruby_aem/resources/flush_agent.rb
 - lib/ruby_aem/resources/group.rb
@@ -125,6 +128,8 @@ files:
 - lib/ruby_aem/resources/replication_agent.rb
 - lib/ruby_aem/resources/repository.rb
 - lib/ruby_aem/resources/reverse_replication_agent.rb
+- lib/ruby_aem/resources/saml.rb
+- lib/ruby_aem/resources/truststore.rb
 - lib/ruby_aem/resources/user.rb
 - lib/ruby_aem/response.rb
 - lib/ruby_aem/result.rb
@@ -141,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="