aspera-cli 4.4.0 → 4.7.0

data/lib/aspera/cli/plugins/faspex5.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'aspera/cli/basic_auth_plugin'
 require 'aspera/persistency_action_once'
 require 'aspera/id_generator'
@@ -7,96 +8,102 @@ module Aspera
   module Cli
     module Plugins
       class Faspex5 < BasicAuthPlugin
+        class << self
+          def detect(base_url)
+            api=Rest.new({base_url: base_url})
+            result=api.read('api/v5/configuration/ping')
+            if result[:http].code.start_with?('2') && result[:http].body.strip.empty?
+              return {version: '5'}
+            end
+            return nil
+          end
+        end
+
         VAL_ALL='ALL'
+        TRANSFER_CONNECT='connect'
+        private_constant :VAL_ALL,:TRANSFER_CONNECT
+
         def initialize(env)
           super(env)
-          options.add_opt_simple(:client_id,'API client identifier in application')
-          options.add_opt_simple(:client_secret,'API client secret in application')
-          options.add_opt_simple(:redirect_uri,'API client redirect URI')
-          options.add_opt_list(:auth,Oauth.auth_types.clone.push(:boot),'type of Oauth authentication')
-          options.add_opt_simple(:private_key,'RSA private key PEM value for JWT (prefix file path with @val:@file:)')
+          options.add_opt_simple(:client_id,'OAuth client identifier')
+          options.add_opt_simple(:client_secret,'OAuth client secret')
+          options.add_opt_simple(:redirect_uri,'OAuth redirect URI')
+          options.add_opt_list(:auth,[Oauth::STD_AUTH_TYPES,:boot].flatten,'OAuth type of authentication')
+          options.add_opt_simple(:private_key,'Oauth RSA private key PEM value for JWT (prefix file path with @val:@file:)')
           options.set_option(:auth,:jwt)
           options.parse_options!
         end
 
         def set_api
-          @faxpex5_api_base_url=options.get_option(:url,:mandatory)
-          faxpex5_api_v5_url="#{@faxpex5_api_base_url}/api/v5"
-          faxpex5_api_auth_url="#{@faxpex5_api_base_url}/auth"
+          faxpex5_api_base_url=options.get_option(:url,:mandatory)
+          faxpex5_api_v5_url="#{faxpex5_api_base_url}/api/v5"
+          @faxpex5_api_auth_url="#{faxpex5_api_base_url}/auth"
           case options.get_option(:auth,:mandatory)
           when :boot
             # the password here is the token copied directly from browser in developer mode
             @api_v5=Rest.new({
-              :base_url => faxpex5_api_v5_url,
-              :headers => {'Authorization'=>options.get_option(:password,:mandatory)},
+              base_url:  faxpex5_api_v5_url,
+              headers:  {'Authorization'=>options.get_option(:password,:mandatory)}
             })
           when :web
             # opens a browser and ask user to auth using web
             @api_v5=Rest.new({
-              :base_url => faxpex5_api_v5_url,
-              :auth     => {
-              :type           => :oauth2,
-              :base_url       => faxpex5_api_auth_url,
-              :grant          => :web,
-              :state          => SecureRandom.uuid,
-              :client_id      => options.get_option(:client_id,:mandatory),
-              :redirect_uri   => options.get_option(:redirect_uri,:mandatory),
+              base_url:  faxpex5_api_v5_url,
+              auth:      {
+              type:        :oauth2,
+              base_url:    @faxpex5_api_auth_url,
+              crtype:      :web,
+              client_id:   options.get_option(:client_id,:mandatory),
+              web:         {redirect_uri: options.get_option(:redirect_uri,:mandatory)}
               }})
           when :jwt
-            # currently Faspex 5 beta 3 only supports non-user based apis (e.g. jobs)
             app_client_id=options.get_option(:client_id,:mandatory)
             @api_v5=Rest.new({
-              :base_url => faxpex5_api_v5_url,
-              :auth     => {
-              :type                => :oauth2,
-              :base_url            => faxpex5_api_auth_url,
-              :grant               => :jwt,
-              :f5_username         => options.get_option(:username,:mandatory),
-              :f5_password         => options.get_option(:password,:mandatory),
-              :client_id           => app_client_id,
-              :client_secret       => options.get_option(:client_secret,:mandatory),
-              :jwt_subject         => "client:#{app_client_id}", # TODO Mmmm
-              :jwt_audience        => app_client_id, # TODO Mmmm
-              :jwt_private_key_obj => OpenSSL::PKey::RSA.new(options.get_option(:private_key,:mandatory)),
-              :jwt_headers         => {typ: 'JWT'}
+              base_url:  faxpex5_api_v5_url,
+              auth:      {
+              type:        :oauth2,
+              base_url:    @faxpex5_api_auth_url,
+              crtype:      :jwt,
+              client_id:   app_client_id,
+              jwt:         {
+                payload:     {
+                  iss: app_client_id,    # issuer
+                  aud: app_client_id,    # audience TODO: ???
+                  sub: "user:#{options.get_option(:username,:mandatory)}" # subject also "client:#{app_client_id}" + auth user/pass
+                },
+                #auth:                {type: :basic, options.get_option(:username,:mandatory), options.get_option(:password,:mandatory),
+                private_key_obj:  OpenSSL::PKey::RSA.new(options.get_option(:private_key,:mandatory)),
+                headers:          {typ: 'JWT'}
+              }
               }})
           end
         end
 
-        ACTIONS=[ :node, :package, :auth_client, :jobs ]
+        ACTIONS=[:package, :admin].freeze
 
-        #
         def execute_action
           set_api
           command=options.get_next_command(ACTIONS)
           case command
-          when :auth_client
-            api_auth=Rest.new(@api_v5.params.merge({base_url: "#{@faxpex5_api_base_url}/auth"}))
-            return self.entity_action(api_auth,'oauth_clients',nil,:id,nil,true)
-          when :node
-            return self.entity_action(@api_v5,'nodes',nil,:id,nil,true)
-          when :jobs
-            # to test JWT
-            return self.entity_action(@api_v5,'jobs',nil,:id,nil,true)
           when :package
             command=options.get_next_command([:list,:show,:send,:receive])
             case command
             when :list
               parameters=options.get_option(:value,:optional)
-              return {:type => :object_list, :data=>@api_v5.read('packages',parameters)[:data]['packages']}
+              return {type: :object_list, data: @api_v5.read('packages',parameters)[:data]['packages'], fields: %w[id title release_date total_bytes total_files created_time state]}
             when :show
-              id=options.get_option(:id,:mandatory)
-              return {:type => :single_object, :data=>@api_v5.read("packages/#{id}")[:data]}
+              id=instance_identifier()
+              return {type: :single_object, data: @api_v5.read("packages/#{id}")[:data]}
             when :send
               parameters=options.get_option(:value,:mandatory)
               raise CliBadArgument,'value must be hash, refer to API' unless parameters.is_a?(Hash)
               package=@api_v5.create('packages',parameters)[:data]
-              transfer_spec=@api_v5.create("packages/#{package['id']}/transfer_spec/upload",{transfer_type: 'Connect'})[:data]
+              transfer_spec=@api_v5.create("packages/#{package['id']}/transfer_spec/upload",{transfer_type: TRANSFER_CONNECT})[:data]
               transfer_spec.delete('authentication')
-              return Main.result_transfer(self.transfer.start(transfer_spec,{:src=>:node_gen3}))
+              return Main.result_transfer(transfer.start(transfer_spec,{src: :node_gen3}))
             when :receive
               pkg_type='received'
-              pack_id=options.get_option(:id,:mandatory)
+              pack_id=instance_identifier()
               package_ids=[pack_id]
               skip_ids_data=[]
               skip_ids_persistency=nil
@@ -113,24 +120,40 @@ module Aspera
                 parameters||={'type'=>'received','subtype'=>'mypackages','limit'=>1000}
                 raise CliBadArgument,'value filter must be Hash (API GET)' unless parameters.is_a?(Hash)
                 package_ids=@api_v5.read('packages',parameters)[:data]['packages'].map{|p|p['id']}
-                package_ids.select!{|i|!skip_ids_data.include?(i)}
+                package_ids.reject!{|i|skip_ids_data.include?(i)}
               end
               result_transfer=[]
-              package_ids.each do |id|
+              package_ids.each do |pkgid|
                 # TODO: allow from sent as well ?
-                transfer_spec=@api_v5.create("packages/#{id}/transfer_spec/download",{transfer_type: 'Connect', type: pkg_type})[:data]
+                transfer_spec=@api_v5.create("packages/#{pkgid}/transfer_spec/download",{transfer_type: TRANSFER_CONNECT, type: pkg_type})[:data]
                 transfer_spec.delete('authentication')
-                statuses=self.transfer.start(transfer_spec,{:src=>:node_gen3})
-                result_transfer.push({'package'=>id,Main::STATUS_FIELD=>statuses})
+                statuses=transfer.start(transfer_spec,{src: :node_gen3})
+                result_transfer.push({'package'=>pkgid,Main::STATUS_FIELD=>statuses})
                 # skip only if all sessions completed
-                skip_ids_data.push(id) if TransferAgent.session_status(statuses).eql?(:success)
+                skip_ids_data.push(pkgid) if TransferAgent.session_status(statuses).eql?(:success)
               end
               skip_ids_persistency.save unless skip_ids_persistency.nil?
               return Main.result_transfer_multiple(result_transfer)
+            end # case package
+          when :admin
+            case options.get_next_command([:resource])
+            when :resource
+              res_type=options.get_next_command([:accounts, :contacts, :jobs, :workgroups, :shared_inboxes, :nodes, :oauth_clients, :registrations, :saml_configs])
+              res_path=res_type.to_s
+              display_fields=
+              case res_type
+              when :accounts then [:all_but,'user_profile_data_attributes']
+              when :oauth_clients then [:all_but,'public_key']
+              end
+              adm_api=@api_v5
+              if res_type.eql?(:oauth_clients)
+                adm_api=Rest.new(@api_v5.params.merge({base_url: @faxpex5_api_auth_url}))
+              end
+              return entity_action(adm_api,res_path,use_subkey: true, display_fields: display_fields)
             end
-          end
-        end
-      end
+          end # case command
+        end # action
+      end # Faspex5
     end # Plugins
   end # Cli
 end # Aspera