Class: Travis::CLI::Sshkey
Constant Summary
Constants inherited
from RepoCommand
RepoCommand::GIT_REGEX, RepoCommand::TRAVIS
Constants inherited
from Command
Command::DAY, Command::HOUR, Command::MINUTE, Command::WEEK
Tools::Assets::BASE
Instance Attribute Summary
Attributes inherited from RepoCommand
#slug
Attributes inherited from ApiCommand
#enterprise_name, #session
Attributes inherited from Command
#arguments, #config, #debug, #force_interactive, #formatter, #input, #output
Instance Method Summary
collapse
Methods inherited from RepoCommand
#repository, #setup
Methods inherited from ApiCommand
#authenticate, #detected_endpoint?, #endpoint_config, #enterprise?, #initialize, #org?, #pro?, #setup, #sync
#access_token, #access_token=, #account, #accounts, #api_endpoint, #api_endpoint=, #artifact, #broadcasts, #build, #cancel, #explicit_api_endpoint?, #github_auth, #hooks, #job, #lint, #listen, #logout, #regenerate_token, #remove_token, #repo, #repos, #restart, #user
Methods inherited from Command
abstract, abstract?, #check_completion, #check_ruby, #check_version, command_name, #command_name, #debug?, description, #error, #execute, #help, #info, #initialize, #last_check, #on_signal, #parse, #say, #setup, skip, subcommands, #terminal, #time, #usage, #usage_for, #warn, #write_to
asset, asset_path
Methods included from Parser
#new, #on, #on_initialize
Instance Method Details
#check_access(gh) ⇒ Object
99
100
101
102
103
|
# File 'lib/travis/cli/sshkey.rb', line 99
def check_access(gh)
gh["repos/#{slug}"]
rescue GH::Error
error "GitHub account has no read access to #{color slug, :bold}"
end
|
#delete_key ⇒ Object
48
49
50
51
52
53
54
55
|
# File 'lib/travis/cli/sshkey.rb', line 48
def delete_key
return if interactive? && !danger_zone?("Remove SSH key for #{color slug, :info}?")
say "Removing ssh key for #{color slug, :info}"
ssh_key.delete
rescue Travis::Client::NotFound
warn 'no key found to remove'
end
|
#display_key ⇒ Object
31
32
33
34
35
36
37
|
# File 'lib/travis/cli/sshkey.rb', line 31
def display_key
say "Current SSH key: #{color(ssh_key.description, :info)}"
say "Finger print: #{color(ssh_key.fingerprint, :info)}"
rescue Travis::Client::NotFound
say 'No custom SSH key installed.'
exit 1 if check?
end
|
#generate_key ⇒ Object
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# File 'lib/travis/cli/sshkey.rb', line 57
def generate_key
access_token = nil
github.with_token do |token|
access_token = github_auth(token)
end
raise Travis::Client::GitHubLoginFailed, 'all GitHub tokens given were invalid' unless access_token
gh = GH.with(token: github_token)
login = gh['user']['login']
check_access(gh)
empty_line
say 'Generating RSA key.'
private_key = Tools::SSLKey.generate_rsa
self.description ||= "key for fetching dependencies for #{slug} via #{login}"
say 'Uploading public key to GitHub.'
gh.post('/user/keys', title: "#{description} (Travis CI)",
key: Tools::SSLKey.rsa_ssh(private_key.public_key))
say 'Uploading private key to Travis CI.'
ssh_key.update(value: private_key.to_s, description:)
empty_line
say 'You can store the private key to reuse it for other repositories (travis sshkey --upload FILE).'
return unless agree('Store private key? ') { |q| q.default = 'no' }
path = ask('Path: ') { |q| q.default = 'id_travis_rsa' }
File.write(path, private_key.to_s)
end
|
#github ⇒ Object
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# File 'lib/travis/cli/sshkey.rb', line 105
def github
@github ||= begin
load_gh
Tools::Github.new(session.config['github']) do |g|
g.note = "token for fetching dependencies for #{slug} (Travis CI)"
g.explode = explode?
g.github_token = github_token
g. = proc { }
g.debug = proc { |log| debug(log) }
g.after_tokens = proc { g.explode = true and error('no suitable github token found') }
end
end
end
|
119
120
121
122
123
|
# File 'lib/travis/cli/sshkey.rb', line 119
def
say 'GitHub deprecated its Authorizations API exchanging a password for a token.'
say 'Please visit https://github.blog/2020-07-30-token-authentication-requirements-for-api-and-git-operations for more information.'
say "Try running with #{color('--github-token', :info)} or #{color('--auto-token', :info)} ."
end
|
#remove_passphrase(value) ⇒ Object
88
89
90
91
92
93
94
95
96
97
|
# File 'lib/travis/cli/sshkey.rb', line 88
def remove_passphrase(value)
return value unless Tools::SSLKey.has_passphrase? value
return Tools::SSLKey.remove_passphrase(value, passphrase) || error('wrong pass phrase') if passphrase
error 'Key is encrypted, but missing --passphrase option' unless interactive?
say 'The private key is protected by a pass phrase.'
result = Tools::SSLKey.remove_passphrase(value, ask('Enter pass phrase: ') { |q| q.echo = '*' }) until result
empty_line
result
end
|
#run ⇒ Object
22
23
24
25
26
27
28
29
|
# File 'lib/travis/cli/sshkey.rb', line 22
def run
error "SSH keys are not available on #{color(session.config['host'], :bold)}" if org?
delete_key if delete?
update_key File.read(upload), upload if upload?
update_key $stdin.read, 'stdin' if stdin?
generate_key if generate?
display_key
end
|
#update_key(value, file) ⇒ Object
39
40
41
42
43
44
45
46
|
# File 'lib/travis/cli/sshkey.rb', line 39
def update_key(value, file)
error "#{file} does not look like a private key" unless value.lines.first =~ /PRIVATE KEY/
value = remove_passphrase(value)
self.description ||= ask('Key description: ') { |q| q.default = 'Custom Key' } if interactive?
say "Updating ssh key for #{color slug, :info} with key from #{color file, :info}"
empty_line
ssh_key.update(value:, description: description || file)
end
|