Class: Aspera::Cli::Plugins::Server

Inherits:
BasicAuth show all
Includes:
SyncActions
Defined in:
lib/aspera/cli/plugins/server.rb

Overview

Operations on HSTS with SSH/FASP (ascmd/ascp)

Defined Under Namespace

Classes: LocalExecutor

Constant Summary collapse

LOCAL_SCHEME = 
'local'
HTTPS_SCHEME = 
'https'
BASE_ACTIONS =

actions without ascmd

%i[health].concat(TRANSFER_COMMANDS).freeze
ACTIONS =

all actions

[BASE_ACTIONS, AsCmd::OPERATIONS, ASCMD_ALIASES.keys].flatten.freeze

Constants included from SyncActions

SyncActions::STATE_STR

Constants inherited from Base

Base::ALL_OPS, Base::GLOBAL_OPS, Base::INSTANCE_OPS, Base::MAX_ITEMS, Base::MAX_PAGES, Base::REGEX_LOOKUP_ID_BY_FIELD

Instance Attribute Summary

Attributes inherited from Base

#context

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SyncActions

#async_info_from_args, #db_from_args, declare_options, #execute_sync_action

Methods inherited from BasicAuth

#basic_auth_api, #basic_auth_params, declare_options

Methods inherited from Base

#add_manual_header, #config, declare_options, #do_bulk_operation, #entity_execute, #formatter, #instance_identifier, #list_entities_limit_offset_total_count, #lookup_entity_by_field, #options, #persistency, #query_read_delete, #transfer, #value_create_modify

Constructor Details

#initialize(**_) ⇒ Server

Returns a new instance of Server.



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/aspera/cli/plugins/server.rb', line 86

def initialize(**_)
  super
  @ssh_opts = {}
  @connection_type = :ssh
  options.declare(:ssh_keys, 'SSH key path list (Array or single)')
  options.declare(:passphrase, 'SSH private key passphrase')
  options.declare(:ssh_options, 'SSH options', types: Hash, handler: {o: self, m: :option_ssh_opts})
  SyncActions.declare_options(options)
  options.parse_options!
end

Class Method Details

.application_name ⇒ Object 



40
41
42
 
# File 'lib/aspera/cli/plugins/server.rb', line 40

def application_name
  'HSTS Fasp/SSH'
end

.detect(address_or_url) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/aspera/cli/plugins/server.rb', line 44

def detect(address_or_url)
  urls = if address_or_url.match?(%r{^[a-z]{1,6}://})
    [address_or_url]
  else
    [
      "#{SSH_SCHEME}://#{address_or_url}:33001",
      "#{SSH_SCHEME}://#{address_or_url}:22"
    ]
    # wss not practical as it requires a token
  end
  error = nil
  urls.each do |base_url|
    server_uri = URI.parse(base_url)
    Log.log.debug{"URI=#{server_uri}, host=#{server_uri.hostname}, port=#{server_uri.port}, scheme=#{server_uri.scheme}"}
    next unless server_uri.scheme.eql?(SSH_SCHEME)
    socket = TCPSocket.new(server_uri.hostname, server_uri.port)
    socket.puts('SSH-2.0-Ascli_0.0')
    version = socket.gets.chomp
    return {version: version.gsub(/^SSH-2.0-/, ''), url: base_url} if version.match?(/^SSH-2.0-/)
  rescue StandardError => e
    error = e
    Log.log.debug{"detect error: #{e}"}
  end
  raise error if error
  return
end

Instance Method Details

#execute_action ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/aspera/cli/plugins/server.rb', line 197

def execute_action
  server_transfer_spec = options_to_base_transfer_spec
  ascmd_executor = case @connection_type
  when :local then LocalExecutor.new
  when :wss then nil
  when :ssh then Ssh.new(server_transfer_spec['remote_host'], server_transfer_spec['remote_user'], @ssh_opts)
  else Aspera.error_unexpected_value(@connection_type){'connection type'}
  end
  # the set of available commands depends on SSH executor availability (i.e. no WSS)
  available_commands = ascmd_executor.nil? ? BASE_ACTIONS : ACTIONS
  # get command and translate aliases
  command = options.get_next_command(available_commands)
  command = ASCMD_ALIASES[command] if ASCMD_ALIASES.key?(command)
  case command
  when :health
    nagios = Nagios.new
    command_nagios = options.get_next_command(%i[transfer])
    case command_nagios
    when :transfer
      probe_ts = server_transfer_spec.merge({
        'direction'     => 'send',
        'cookie'        => 'aspera.sync', # hide in console
        'resume_policy' => 'none',
        'paths'         => [{'source' => 'faux:///pingfile?1k', 'destination' => '.fasping'}]
      })
      statuses = transfer.start(probe_ts)
      if TransferAgent.session_status(statuses).eql?(:success)
        nagios.add_ok('transfer', 'ok')
      else
        nagios.add_critical('transfer', statuses.reject{ |i| i.eql?(:success)}.first.to_s)
      end
    else Aspera.error_unexpected_value(command_nagios)
    end
    return nagios.result
  when *TRANSFER_COMMANDS
    return execute_transfer(command, server_transfer_spec)
  when *AsCmd::OPERATIONS
    command_arguments = options.get_next_argument('ascmd command arguments', multiple: true, mandatory: false)
    ascmd = AsCmd.new(ascmd_executor)
    begin
      result = ascmd.execute_single(command, command_arguments)
      case command
      when :mkdir, :mv, :cp, :rm
        return Main.result_success
      when :ls
        return Main.result_object_list(result.map(&:stringify_keys), fields: %w[zmode zuid zgid size mtime name])
      when :df
        return Main.result_object_list(result.map(&:stringify_keys))
      when :du, :md5sum, :info
        return Main.result_single_object(result.stringify_keys)
      end
    rescue AsCmd::Error => e
      raise Cli::BadArgument, e.extended_message
    end
  else Aspera.error_unreachable_line
  end
end

#execute_transfer(command, transfer_spec) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/aspera/cli/plugins/server.rb', line 181

def execute_transfer(command, transfer_spec)
  case command
  when :upload, :download
    transfer_spec['direction'] = Transfer::Spec.transfer_type_to_direction(command)
    return Main.result_transfer(transfer.start(transfer_spec))
  when :sync
    # lets ignore the arguments provided by execute_sync_action, we just give the transfer spec
    return execute_sync_action{transfer_spec}
  end
end

#option_ssh_opts ⇒ Object 



97
 
# File 'lib/aspera/cli/plugins/server.rb', line 97

def option_ssh_opts; @ssh_opts; end

#option_ssh_opts=(value) ⇒ Object

multiple option are merged



100
101
102
103
 
# File 'lib/aspera/cli/plugins/server.rb', line 100

def option_ssh_opts=(value)
  Aspera.assert_type(value, Hash)
  @ssh_opts.deep_merge!(value.compact.symbolize_keys)
end

#options_to_base_transfer_spec ⇒ Hash

Read command line options

Returns:

  • (Hash) —

    transfer specification



107
108
109
110
111
112
113
114
115
116
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
151
152
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
 
# File 'lib/aspera/cli/plugins/server.rb', line 107

def options_to_base_transfer_spec
  url = options.get_option(:url, mandatory: true)
  server_transfer_spec = {}
  server_uri = URI.parse(url)
  Log.log.debug{"URI=#{server_uri}, host=#{server_uri.hostname}, port=#{server_uri.port}, scheme=#{server_uri.scheme}"}
  server_transfer_spec['remote_host'] = server_uri.hostname
  unless URI_SCHEMES.include?(server_uri.scheme)
    Log.log.warn{"Scheme [#{server_uri.scheme}] not supported in #{url}, use one of: #{URI_SCHEMES.join(', ')}. Defaulting to #{SSH_SCHEME}."}
    server_uri.scheme = SSH_SCHEME
  end
  if server_uri.scheme.eql?(LOCAL_SCHEME)
    # Using local execution (mostly for testing)
    server_transfer_spec['remote_host'] = 'localhost'
    # simulate SSH environment, else ascmd will fail
    ENV['SSH_CLIENT'] = 'local 0 0'
    @connection_type = :local
    return server_transfer_spec
  elsif transfer.option_transfer_spec['token'].is_a?(String) && server_uri.scheme.eql?(HTTPS_SCHEME)
    server_transfer_spec['wss_enabled'] = true
    server_transfer_spec['wss_port'] = server_uri.port
    @connection_type = :wss
    # Using WSS
    return server_transfer_spec
  end
  if !server_uri.scheme.eql?(SSH_SCHEME)
    Log.log.warn('URL scheme is https but no token was provided in transfer spec.')
    Log.log.warn("If you want to access the server, not using WSS for session, then use a URL with scheme \"#{SSH_SCHEME}\" and proper SSH port")
    assumed_url = "#{SSH_SCHEME}://#{server_transfer_spec['remote_host']}:#{Transfer::Spec::SSH_PORT}"
    Log.log.warn{"Assuming proper URL is: #{assumed_url}"}
    server_uri = URI.parse(assumed_url)
  end
  # Scheme is SSH
  if options.get_option(:username).nil?
    options.set_option(:username, Transfer::Spec::ACCESS_KEY_TRANSFER_USER)
    Log.log.info{"No username provided: Assuming default transfer user: #{Transfer::Spec::ACCESS_KEY_TRANSFER_USER}"}
  end
  server_transfer_spec['remote_user'] = options.get_option(:username, mandatory: true)
  if !server_uri.port.nil?
    @ssh_opts[:port] = server_uri.port
    server_transfer_spec['ssh_port'] = server_uri.port
  end
  cred_set = false
  password = options.get_option(:password)
  if !password.nil?
    @ssh_opts[:password] = password
    server_transfer_spec['remote_password'] = password
    cred_set = true
  end
  ssh_key_list = options.get_option(:ssh_keys)
  if !ssh_key_list.nil?
    ssh_key_list = [ssh_key_list] if ssh_key_list.is_a?(String)
    Aspera.assert_type(ssh_key_list, Array){'ssh_keys'}
    Aspera.assert(ssh_key_list.all?(String))
    ssh_key_list.map!{ |p| File.expand_path(p)}
    Log.log.debug{"SSH keys=#{ssh_key_list}"}
    if !ssh_key_list.empty?
      @ssh_opts[:keys] = ssh_key_list
      # PEM as per RFC 7468
      server_transfer_spec['ssh_private_key'] = File.read(ssh_key_list.first).strip
      Log.log.warn{'Using only first SSH key for transfers'} unless ssh_key_list.length.eql?(1)
      cred_set = true
    end
  end
  ssh_passphrase = options.get_option(:passphrase)
  if !ssh_passphrase.nil?
    @ssh_opts[:passphrase] = ssh_passphrase
    server_transfer_spec['ssh_private_key_passphrase'] = ssh_passphrase
  end
  # if user provided transfer spec has a token, we will use bypass keys
  cred_set = true if transfer.option_transfer_spec['token'].is_a?(String)
  Aspera.assert(cred_set, type: BadArgument){'Either password, key , or transfer spec token must be provided'}
  return server_transfer_spec
end

#wizard(wizard, app_url) ⇒ Hash

Returns :preset_value, :test_args.

Parameters:

  • wizard (Wizard) —

    The wizard object

  • app_url (Wizard) —

    The wizard object

Returns:

  • (Hash) —

    :preset_value, :test_args



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/aspera/cli/plugins/server.rb', line 75

def wizard(wizard, app_url)
  return {
    preset_value: {
      url:      app_url,
      username: options.get_option(:username, mandatory: true),
      password: options.get_option(:password, mandatory: true)
    },
    test_args:    'files browse /'
  }
end