Class: Kontena::Cli::Master::LoginCommand

Inherits:
Kontena::Command show all
Includes:
Common
Defined in:
lib/kontena/cli/master/login_command.rb

Instance Attribute Summary

Attributes inherited from Kontena::Command

#arguments, #exit_code, #result

Instance Method Summary collapse

Methods included from Common

#access_token=, #add_master, #any_key_to_continue, #any_key_to_continue_with_timeout, #api_url, #api_url=, #caret, #clear_current_grid, #client, #cloud_auth?, #cloud_client, #config, #confirm, #confirm_command, #current_grid, #current_master_index, #debug?, #display_account_login_info, #display_login_info, display_logo, #display_master_login_info, #error, exit_with_error, #kontena_account, #logger, #pastel, #print, #prompt, #puts, #require_api_url, #require_token, #reset_client, #reset_cloud_client, #running_quiet?, #running_silent?, #running_verbose?, #spin_if, #spinner, #sprint, #sputs, #stdin_input, #use_refresh_token, #vfakespinner, #vputs, #vspinner, #warning

Methods inherited from Kontena::Command

banner, callback_matcher, #help_requested?, inherited, #instance, load_subcommand, requires_current_account_token, requires_current_account_token?, requires_current_grid, requires_current_grid?, requires_current_master, requires_current_master?, requires_current_master_token, requires_current_master_token?, #run, #run_callbacks, #verify_current_account_token, #verify_current_grid, #verify_current_master, #verify_current_master_token

Instance Method Details

#auth_works?(server) ⇒ Boolean

Check if the existing (or –token) authentication works without reauthenticating

Returns:

  • (Boolean) 


112
113
114
115
116
117
 
# File 'lib/kontena/cli/master/login_command.rb', line 112

def auth_works?(server)
  return false unless (server && server.token && server.token.access_token)
   "Testing if authentication works using current access token" do
    Kontena::Client.new(server.url, server.token).authentication_ok?(.userinfo_endpoint)
  end
end

#authentication_path(local_port: nil, invite_code: nil, expires_in: nil, remote: false) ⇒ String

Build a path for master authentication

Parameters:

  • local_port (Fixnum) (defaults to: nil) —

    tcp port where localhost webserver is listening

  • invite_code (String) (defaults to: nil) —

    an invitation code generated when user was invited

  • expires_in (Fixnum) (defaults to: nil) —

    expiration time for the requested access token

  • remote (Boolean) (defaults to: false) —

    true when performing a login where the code is displayed on the web page

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/kontena/cli/master/login_command.rb', line 126

def authentication_path(local_port: nil, invite_code: nil, expires_in: nil, remote: false)
  auth_url_params = {}
  if remote
    auth_url_params[:redirect_uri] = "/code"
  elsif local_port
    auth_url_params[:redirect_uri] = "http://localhost:#{local_port}/cb"
  else
    raise ArgumentError, "Local port not defined and not performing remote login"
  end
  auth_url_params[:invite_code]  = invite_code if invite_code
  auth_url_params[:expires_in]   = expires_in  if expires_in
  "/authenticate?#{URI.encode_www_form(auth_url_params)}"
end

#authentication_url_from_master(master_url, auth_params) ⇒ String

Request a redirect to the authentication url from master

Parameters:

  • master_url (String) —

    master root url

  • auth_params (Hash) —

    auth parameters (keyword arguments of #authentication_path)

Returns:

  • (String) —

    url to begin authentication web flow



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/kontena/cli/master/login_command.rb', line 145

def authentication_url_from_master(master_url, auth_params)
  client = Kontena::Client.new(master_url)
   "Sending authentication request to receive an authorization URL" do
    response = client.request(
      http_method: :get,
      path: authentication_path(auth_params),
      expects: [501, 400, 302, 403],
      auth: false
    )

    if client.last_response.status == 302
      client.last_response.headers['Location']
    elsif response.kind_of?(Hash)
      exit_with_error [response['error'], response['error_description']].compact.join(' : ')
    elsif response.kind_of?(String) && response.length > 1
      exit_with_error response
    else
      exit_with_error "Invalid response to authentication request : HTTP#{client.last_response.status} #{client.last_response.body if debug?}"
    end
  end
end

#display_remote_message(server, auth_params) ⇒ Object 



167
168
169
170
171
172
173
174
175
 
# File 'lib/kontena/cli/master/login_command.rb', line 167

def display_remote_message(server, auth_params)
  url = authentication_url_from_master(server.url, auth_params.merge(remote: true))
  if running_silent?
    sputs url
  else
    puts "Visit this URL in a browser:"
    puts "#{url}"
  end
end

#execute ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/kontena/cli/master/login_command.rb', line 21

def execute
  if self.code
    exit_with_error "Can't use --token and --code together" if self.token
    exit_with_error "Can't use --join and --code together" if self.join
  end

  if self.force?
    exit_with_error "Can't use --code and --force together" if self.code
    exit_with_error "Can't use --token and --force together" if self.token
  end

  server = select_a_server(self.name, self.url)

  if self.token
    # If a --token was given create a token with access_token set to --token value
    server.token = Kontena::Cli::Config::Token.new(access_token: self.token, parent_type: :master, parent_name: server.name)
  elsif server.token.nil? || self.force?
    # Force reauth or no existing token, create a token with no access_token
    server.token = Kontena::Cli::Config::Token.new(parent_type: :master, parent_name: server.name)
  end

  if self.grid
    self.skip_grid_auto_select = true if self.respond_to?(:skip_grid_auto_select?)
    server.grid = self.grid
  end

  # set server token by exchanging code if --code given
  if self.code
    use_authorization_code(server, self.code)
    exit 0
  end

  # unless an invitation code was supplied, check auth and exit
  # if existing auth works already.
  unless self.join || self.force?
    if auth_works?(server)
      update_server_to_config(server)
      (only: :master) unless self.
      exit 0
    end
  end

  auth_params = {
    remote: self.remote?,
    invite_code: self.join,
    expires_in: self.expires_in
  }

  if self.remote?
    # no local browser? tell user to launch an external one
    display_remote_message(server, auth_params)
    auth_code = prompt.ask("Enter code displayed in browser:")
    use_authorization_code(server, auth_code)
  else
    # local web flow
    web_flow(server, auth_params)
  end

  (only: :master) unless (running_silent? || self.)
end

#master_account ⇒ Object 



99
100
101
 
# File 'lib/kontena/cli/master/login_command.rb', line 99

def 
  @master_account ||= config.('master')
end

#next_default_name ⇒ Object 



82
83
84
 
# File 'lib/kontena/cli/master/login_command.rb', line 82

def next_default_name
  next_name('kontena-master')
end

#next_name(base) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/kontena/cli/master/login_command.rb', line 86

def next_name(base)
  if config.find_server(base)
    new_name = base.dup
    unless new_name =~ /\-\d+$/
      new_name += "-2"
    end
    new_name.succ! until config.find_server(new_name).nil?
    new_name
  else
    base
  end
end

#select_a_server(name, url) ⇒ Kontena::Cli::Config::Server

Figure out or create a server based on url or name.

No name or url provided: try to use current_master A name provided with –name but no url defined: try to find a server by name from config An URL starting with ‘http’ provided: try to find a server by url from config An URL not starting with ‘http’ provided: try to find a server by name An URL and a name provided

- If a server is found by name: use entry and update URL to the provided url
- Else create a new entry with the url and name

Parameters:

  • name (String) —

    master name

  • url (String) —

    master url or name

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/kontena/cli/master/login_command.rb', line 273

def select_a_server(name, url)
  # no url, no name, try to use current master
  if url.nil? && name.nil?
    if config.current_master
      return config.current_master
    else
      exit_with_error 'URL not specified and current master not selected'
    end
  end

  if name && url
    exact_match = config.find_server_by(url: url, name: name)
    return exact_match if exact_match # found an exact match, going to use that one.

    name_match = config.find_server(name)

    if name_match
      #found a server with the provided name, set the provided url to it and return
      name_match.url = url
      return name_match
    else
      # nothing found, create new.
      return Kontena::Cli::Config::Server.new(name: name, url: url)
    end
  elsif name
    # only --name provided, try to find a server with that name
    name_match = config.find_server(name)

    if name_match && name_match.url
      return name_match
    else
      exit_with_error "Master #{name} was found from config, but it does not have an URL and no URL was provided on command line"
    end
  elsif url
    # only url provided
    if url =~ /^https?:\/\//
      # url is actually an url
      url_match = config.find_server_by(url: url)
      if url_match
        return url_match
      else
        return Kontena::Cli::Config::Server.new(url: url, name: nil)
      end
    else
      name_match = config.find_server(url)
      if name_match
        unless name_match.url
          exit_with_error "Master #{url} was found from config, but it does not have an URL and no URL was provided on command line"
        end
        return name_match
      else
        exit_with_error "Can't find a master with name #{name} from configuration"
      end
    end
  end
end

#update_server(server, response) ⇒ Object 



215
216
217
218
219
 
# File 'lib/kontena/cli/master/login_command.rb', line 215

def update_server(server, response)
  update_server_token(server, response)
  update_server_name(server, response)
  update_server_username(server, response)
end

#update_server_name(server, response) ⇒ Object 



221
222
223
224
225
226
227
228
 
# File 'lib/kontena/cli/master/login_command.rb', line 221

def update_server_name(server, response)
  return nil unless server.name.nil?
  if response.kind_of?(Hash) && response['server'] && response['server']['name']
    server.name = next_name(response['server']['name'])
  else
    server.name = next_default_name
  end
end

#update_server_to_config(server) ⇒ Object 



252
253
254
255
256
257
258
 
# File 'lib/kontena/cli/master/login_command.rb', line 252

def update_server_to_config(server)
  server.name ||= next_default_name
  config.servers << server unless config.servers.include?(server)
  config.current_master = server.name
  config.write
  config.reset_instance
end

#update_server_token(server, response) ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/kontena/cli/master/login_command.rb', line 237

def update_server_token(server, response)
  if !response.kind_of?(Hash)
    raise TypeError, "Response type mismatch - expected Hash, got #{response.class}"
  elsif response['code']
    use_authorization_code(server, response['code'])
  elsif response['error']
    exit_with_error "Authentication failed: #{response['error']} #{response['error_description']}"
  else
    server.token = Kontena::Cli::Config::Token.new
    server.token.access_token  = response['access_token']
    server.token.refresh_token = response['refresh_token']
    server.token.expires_at    = response['expires_at']
  end
end

#update_server_username(server, response) ⇒ Object 



230
231
232
233
234
235
 
# File 'lib/kontena/cli/master/login_command.rb', line 230

def update_server_username(server, response)
  return nil unless response.kind_of?(Hash)
  return nil unless response['user']
  server.token.username = response['user']['name'] || response['user']['email']
  server.username = server.token.username
end

#use_authorization_code(server, code) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/kontena/cli/master/login_command.rb', line 103

def use_authorization_code(server, code)
  response =  "Exchanging authorization code for an access token from Kontena Master" do
    Kontena::Client.new(server.url, server.token).exchange_code(code)
  end
  update_server(server, response)
  update_server_to_config(server)
end

#web_flow(server, auth_params) ⇒ Object 



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
 
# File 'lib/kontena/cli/master/login_command.rb', line 177

def web_flow(server, auth_params)
  require_relative '../localhost_web_server'
  require 'kontena/cli/browser_launcher'


  web_server = Kontena::LocalhostWebServer.new

  url = authentication_url_from_master(server.url, auth_params.merge(local_port: web_server.port))
  uri = URI.parse(url)

  puts "Opening a browser to #{uri.scheme}://#{uri.host}"
  puts
  puts "If you are running this command over an ssh connection or it's"
  puts "otherwise not possible to open a browser from this terminal"
  puts "then you must use the --remote flag or use a pregenerated"
  puts "access token using the --token option."
  puts
  puts "Once the authentication is complete you can close the browser"
  puts "window or tab and return to this window to continue."
  puts

  any_key_to_continue(10)

  puts "If the browser does not open, try visiting this URL manually:"
  puts "#{uri.to_s}"
  puts

  server_thread  = Thread.new { Thread.main['response'] = web_server.serve_one }
  Kontena::Cli::BrowserLauncher.open(uri.to_s)

   "Waiting for browser authorization response" do
    server_thread.join
  end

  update_server(server, Thread.main['response'])
  update_server_to_config(server)
end