Class: Aspera::Transfer::Parameters

Inherits:
Object
  • Object
show all
Defined in:
lib/aspera/transfer/parameters.rb

Overview

Translate transfer specification to ‘ascp` parameter list

Constant Summary collapse

HTTP_FALLBACK_ACTIVATION_VALUES = 
['1', 1, true, 'force'].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job_spec, ascp_args: nil, wss: true, quiet: true, trusted_certs: nil, client_ssh_key: nil, check_ignore_cb: nil) ⇒ Parameters

Returns a new instance of Parameters.

Parameters:

  • job_spec (Hash) —

    Transfer spec

  • ascp_args (Array) (defaults to: nil) —

    Other ascp args

  • quiet (Bool) (defaults to: true) —

    Remove ascp output

  • trusted_certs (Array) (defaults to: nil) —

    Trusted certificates

  • client_ssh_key (Symbol) (defaults to: nil) —

    :rsa or :dsa

  • check_ignore_cb (Proc) (defaults to: nil) —

    Callback



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspera/transfer/parameters.rb', line 54

def initialize(
  job_spec,
  ascp_args:       nil,
  wss:             true,
  quiet:           true,
  trusted_certs:   nil,
  client_ssh_key:  nil,
  check_ignore_cb: nil
)
  @job_spec = job_spec
  Aspera.assert_type(@job_spec, Hash)
  @ascp_args = ascp_args.nil? ? [] : ascp_args
  Aspera.assert_type(@ascp_args, Array){'ascp_args'}
  Aspera.assert(@ascp_args.all?(String)){'all ascp arguments must be String'}
  @wss = wss
  @quiet = quiet
  @trusted_certs = trusted_certs.nil? ? [] : trusted_certs
  Aspera.assert_type(@trusted_certs, Array){'trusted_certs'}
  @client_ssh_key = client_ssh_key.nil? ? :rsa : client_ssh_key.to_sym
  Aspera.assert_values(@client_ssh_key, Ascp::Installation::CLIENT_SSH_KEY_OPTIONS)
  @check_ignore_cb = check_ignore_cb
  @builder = CommandLineBuilder.new(@job_spec, Spec::SCHEMA, CommandLineConverter)
end

Class Method Details

.ascp_args_file_list?(ascp_args) ⇒ Boolean

File list is provided directly with ascp arguments

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/aspera/transfer/parameters.rb', line 43

def ascp_args_file_list?(ascp_args)
  ascp_args&.any?{ |i| FILE_LIST_OPTIONS.include?(i)}
end

.file_list_folder ⇒ Object

Temp folder for file lists, must contain only file lists because of garbage collection takes any file there this could be refined, as, for example, on macos, temp folder is already user specific



37
38
39
 
# File 'lib/aspera/transfer/parameters.rb', line 37

def file_list_folder
  @file_list_folder ||= TempFileManager.instance.new_file_path_global('asession_filelists')
end

.file_list_folder=(value) ⇒ Object

temp file list files are created here



27
28
29
30
31
32
 
# File 'lib/aspera/transfer/parameters.rb', line 27

def file_list_folder=(value)
  @file_list_folder = value
  return if @file_list_folder.nil?
  FileUtils.mkdir_p(@file_list_folder)
  TempFileManager.instance.cleanup_expired(@file_list_folder)
end

Instance Method Details

#ascp_args ⇒ Object

Translate transfer spec to env vars and command line arguments for ‘ascp`



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspera/transfer/parameters.rb', line 153

def ascp_args
  env_args = {
    args: [],
    env:  {},
    name: :ascp
  }

  # Special cases
  @job_spec.delete('source_root') if @job_spec.key?('source_root') && @job_spec['source_root'].empty?

  # Notify multi-session was already used, anyway it was deleted by agent direct
  Aspera.assert(!@builder.read_param('multi_session'))

  # Add ssh or wss certificates
  # (reverse, to keep order, as we unshift)
  remote_certificates&.reverse_each do |cert|
    env_args[:args].unshift('-i', cert)
  end

  case (delete_source = @builder.read_param('delete_source'))
  when true
    DELETE_EQUIV.each{ |i| @job_spec[i] = true}
  when false
    DELETE_EQUIV.each{ |i| @job_spec.delete(i)}
  when nil
  else Aspera.error_unexpected_value(delete_source){'delete_source'}
  end

  # process parameters as specified in table
  @builder.process_params

  base64_destination = false
  # symbol must be index of Ascp::Installation.paths
  if @builder.read_param('use_ascp4')
    env_args[:name] = :ascp4
  else
    env_args[:name] = :ascp
    base64_destination = true
  end
  # destination will be base64 encoded, put this before source path arguments
  @builder.add_command_line_options('--dest64') if base64_destination
  # optional arguments, at the end to override previous ones (to allow override)
  @builder.add_command_line_options(@ascp_args)
  # get list of source files to transfer and build arg for ascp
  process_file_list
  # process destination folder
  destination_folder = @builder.read_param('destination_root') || '/'
  # ascp4 does not support base64 encoding of destination
  destination_folder = Base64.strict_encode64(destination_folder) if base64_destination
  # destination MUST be last command line argument to ascp
  @builder.add_command_line_options(destination_folder)
  @builder.add_env_args(env_args)
  env_args[:args].unshift('-q') if @quiet
  # add fallback cert and key as arguments if needed
  if HTTP_FALLBACK_ACTIVATION_VALUES.include?(@job_spec['http_fallback'])
    env_args[:args].unshift('-Y', Ascp::Installation.instance.path(:fallback_private_key))
    env_args[:args].unshift('-I', Ascp::Installation.instance.path(:fallback_certificate))
  end
  # disable redis in client
  env_args[:env]['ASPERA_TEST_REDIS_DISABLE'] = 'true'
  Log.log.debug{"ascp args: #{env_args}"}
  return env_args
end

#process_file_list ⇒ Object

either place source files on command line, or add file list file



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/aspera/transfer/parameters.rb', line 79

def process_file_list
  # is the file list provided through ascp parameters?
  ascp_file_list_provided = self.class.ascp_args_file_list?(@ascp_args)
  # set if paths is mandatory in ts
  @builder.required('paths', !@job_spec.key?('keepalive') && !ascp_file_list_provided) # cspell:words keepalive
  # get paths in transfer spec (after setting if it is mandatory)
  ts_paths_array = @builder.read_param('paths')
  file_list_option = nil
  # transfer spec contains paths ?
  if !ts_paths_array.nil?
    Aspera.assert(!ascp_file_list_provided){'file list provided both in transfer spec and ascp file list. Remove one of them.'}
    Aspera.assert(ts_paths_array.all?{ |i| i.key?('source')}){"All elements of paths must have a 'source' key"}
    is_pair_list = ts_paths_array.any?{ |i| i.key?('destination')}
    raise "All elements of paths must be consistent with 'destination' key" if is_pair_list && !ts_paths_array.all?{ |i| i.key?('destination')}
    if self.class.file_list_folder.nil?
      Aspera.assert(!is_pair_list){'file pair list is not supported when file list folder is not set'}
      # not safe for special characters ? (maybe not, depends on OS)
      Log.log.debug('placing source file list on command line (no file list file)')
      @builder.add_command_line_options(ts_paths_array.map{ |i| i['source']})
    else
      # safer option: generate a file list file if there is storage defined for it
      if is_pair_list
        file_list_option = '--file-pair-list'
        lines = ts_paths_array.each_with_object([]){ |e, m| m.push(e['source'], e['destination'])}
      else
        file_list_option = '--file-list'
        lines = ts_paths_array.map{ |i| i['source']}
      end
      file_list_file = TempFileManager.instance.new_file_path_in_folder(self.class.file_list_folder)
      Log.dump(:file_list, lines)
      File.write(file_list_file, lines.join("\n"), encoding: 'UTF-8')
      Log.log.debug{"#{file_list_option}=\n#{File.read(file_list_file)}".red}
    end
  end
  @builder.add_command_line_options("#{file_list_option}=#{file_list_file}") unless file_list_option.nil?
end

#remote_certificates ⇒ Object

Returns the list of certificates (option ‘-i`) to use when token/ssh or wss are used.

Returns:

  • the list of certificates (option ‘-i`) to use when token/ssh or wss are used



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/aspera/transfer/parameters.rb', line 117

def remote_certificates
  certificates_to_use = []
  # use web socket secure for session ?
  if @builder.read_param('wss_enabled') && (@wss || !@job_spec.key?('fasp_port'))
    # by default use web socket session if available, unless removed by user
    @builder.add_command_line_options('--ws-connect')
    # TODO: option to give order ssh,ws (legacy http is implied by ssh)
    # This will need to be cleaned up in aspera core
    @job_spec['ssh_port'] = @builder.read_param('wss_port')
    @job_spec.delete('fasp_port')
    @job_spec.delete('sshfp')
    # set location for CA bundle to be the one of Ruby, see env var SSL_CERT_FILE / SSL_CERT_DIR
    certificates_to_use.concat(@trusted_certs)
    # ignore cert for wss ?
    if @check_ignore_cb&.call(@job_spec['remote_host'], @job_spec['wss_port'])
      wss_cert_file = TempFileManager.instance.new_file_path_global('wss_cert')
      wss_url = "https://#{@job_spec['remote_host']}:#{@job_spec['wss_port']}"
      File.write(wss_cert_file, Rest.remote_certificate_chain(wss_url))
      # place in front, as more priority
      certificates_to_use.unshift(wss_cert_file)
    end
    # when wss is used, only first `-i` is used... Hum...
    certificates_to_use = [certificates_to_use.first] unless certificates_to_use.empty?
  else
    # remove unused parameter (avoid warning)
    @job_spec.delete('wss_port')
    # add SSH bypass keys when authentication is token and no auth is provided
    if @job_spec.key?('token') && !@job_spec.key?('remote_password') && !@job_spec.key?('ssh_private_key')
      # @job_spec['remote_password'] = Ascp::Installation.instance.ssh_cert_uuid # not used: no passphrase
      certificates_to_use.concat(Ascp::Installation.instance.aspera_token_ssh_key_paths(@client_ssh_key))
    end
  end
  return certificates_to_use
end