nucleon 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +2 -0
  4. data/VERSION +1 -1
  5. data/lib/core/config.rb +21 -20
  6. data/lib/core/environment.rb +2 -2
  7. data/lib/core/facade.rb +15 -0
  8. data/lib/core/mixin/action/registration.rb +84 -0
  9. data/lib/core/mixin/sub_config.rb +5 -5
  10. data/lib/core/plugin/action.rb +66 -10
  11. data/lib/core/plugin/base.rb +100 -19
  12. data/lib/core/plugin/command.rb +4 -0
  13. data/lib/core/util/cache.rb +13 -1
  14. data/lib/core/util/cli.rb +77 -11
  15. data/lib/core/util/console.rb +55 -72
  16. data/lib/core/util/data.rb +19 -9
  17. data/lib/core/util/logger.rb +16 -6
  18. data/lib/core/util/shell.rb +3 -1
  19. data/lib/core/util/ssh.rb +28 -25
  20. data/lib/nucleon/translator/JSON.rb +2 -2
  21. data/lib/nucleon/translator/YAML.rb +2 -2
  22. data/lib/nucleon_base.rb +22 -8
  23. data/nucleon.gemspec +122 -2
  24. data/rdoc/site/0.2.0/ARCHITECTURE_rdoc.html +638 -0
  25. data/rdoc/site/0.2.0/Hash.html +351 -0
  26. data/rdoc/site/0.2.0/Kernel.html +416 -0
  27. data/rdoc/site/0.2.0/Nucleon.html +607 -0
  28. data/rdoc/site/0.2.0/Nucleon/Action.html +284 -0
  29. data/rdoc/site/0.2.0/Nucleon/Action/Extract.html +455 -0
  30. data/rdoc/site/0.2.0/Nucleon/Action/Project.html +283 -0
  31. data/rdoc/site/0.2.0/Nucleon/Action/Project/Add.html +500 -0
  32. data/rdoc/site/0.2.0/Nucleon/Action/Project/Create.html +457 -0
  33. data/rdoc/site/0.2.0/Nucleon/Action/Project/Remove.html +503 -0
  34. data/rdoc/site/0.2.0/Nucleon/Action/Project/Save.html +476 -0
  35. data/rdoc/site/0.2.0/Nucleon/Action/Project/Update.html +423 -0
  36. data/rdoc/site/0.2.0/Nucleon/Codes.html +567 -0
  37. data/rdoc/site/0.2.0/Nucleon/Command.html +279 -0
  38. data/rdoc/site/0.2.0/Nucleon/Command/Bash.html +548 -0
  39. data/rdoc/site/0.2.0/Nucleon/Config.html +1631 -0
  40. data/rdoc/site/0.2.0/Nucleon/Config/Collection.html +513 -0
  41. data/rdoc/site/0.2.0/Nucleon/Config/Options.html +493 -0
  42. data/rdoc/site/0.2.0/Nucleon/Core.html +639 -0
  43. data/rdoc/site/0.2.0/Nucleon/Environment.html +1208 -0
  44. data/rdoc/site/0.2.0/Nucleon/Errors.html +279 -0
  45. data/rdoc/site/0.2.0/Nucleon/Errors/BatchError.html +285 -0
  46. data/rdoc/site/0.2.0/Nucleon/Errors/NucleonError.html +661 -0
  47. data/rdoc/site/0.2.0/Nucleon/Errors/SSHUnavailable.html +285 -0
  48. data/rdoc/site/0.2.0/Nucleon/Event.html +279 -0
  49. data/rdoc/site/0.2.0/Nucleon/Event/Regex.html +471 -0
  50. data/rdoc/site/0.2.0/Nucleon/Facade.html +2409 -0
  51. data/rdoc/site/0.2.0/Nucleon/Gems.html +639 -0
  52. data/rdoc/site/0.2.0/Nucleon/Manager.html +1860 -0
  53. data/rdoc/site/0.2.0/Nucleon/Mixin.html +288 -0
  54. data/rdoc/site/0.2.0/Nucleon/Mixin/Action.html +281 -0
  55. data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Commit.html +385 -0
  56. data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Project.html +399 -0
  57. data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Push.html +375 -0
  58. data/rdoc/site/0.2.0/Nucleon/Mixin/Colors.html +549 -0
  59. data/rdoc/site/0.2.0/Nucleon/Mixin/ConfigCollection.html +485 -0
  60. data/rdoc/site/0.2.0/Nucleon/Mixin/ConfigOptions.html +453 -0
  61. data/rdoc/site/0.2.0/Nucleon/Mixin/Macro.html +280 -0
  62. data/rdoc/site/0.2.0/Nucleon/Mixin/Macro/ObjectInterface.html +699 -0
  63. data/rdoc/site/0.2.0/Nucleon/Mixin/Macro/PluginInterface.html +686 -0
  64. data/rdoc/site/0.2.0/Nucleon/Mixin/Settings.html +485 -0
  65. data/rdoc/site/0.2.0/Nucleon/Mixin/SubConfig.html +891 -0
  66. data/rdoc/site/0.2.0/Nucleon/Parallel.html +330 -0
  67. data/rdoc/site/0.2.0/Nucleon/Parallel/ClassMethods.html +329 -0
  68. data/rdoc/site/0.2.0/Nucleon/Parallel/InstanceMethods.html +456 -0
  69. data/rdoc/site/0.2.0/Nucleon/Plugin.html +286 -0
  70. data/rdoc/site/0.2.0/Nucleon/Plugin/Action.html +1829 -0
  71. data/rdoc/site/0.2.0/Nucleon/Plugin/Action/Option.html +463 -0
  72. data/rdoc/site/0.2.0/Nucleon/Plugin/Base.html +1803 -0
  73. data/rdoc/site/0.2.0/Nucleon/Plugin/Command.html +725 -0
  74. data/rdoc/site/0.2.0/Nucleon/Plugin/Event.html +446 -0
  75. data/rdoc/site/0.2.0/Nucleon/Plugin/Extension.html +285 -0
  76. data/rdoc/site/0.2.0/Nucleon/Plugin/Project.html +2898 -0
  77. data/rdoc/site/0.2.0/Nucleon/Plugin/Template.html +480 -0
  78. data/rdoc/site/0.2.0/Nucleon/Plugin/Translator.html +375 -0
  79. data/rdoc/site/0.2.0/Nucleon/Project.html +280 -0
  80. data/rdoc/site/0.2.0/Nucleon/Project/Git.html +1805 -0
  81. data/rdoc/site/0.2.0/Nucleon/Project/Github.html +553 -0
  82. data/rdoc/site/0.2.0/Nucleon/Template.html +281 -0
  83. data/rdoc/site/0.2.0/Nucleon/Template/JSON.html +333 -0
  84. data/rdoc/site/0.2.0/Nucleon/Template/Wrapper.html +333 -0
  85. data/rdoc/site/0.2.0/Nucleon/Template/YAML.html +333 -0
  86. data/rdoc/site/0.2.0/Nucleon/Translator.html +280 -0
  87. data/rdoc/site/0.2.0/Nucleon/Translator/JSON.html +370 -0
  88. data/rdoc/site/0.2.0/Nucleon/Translator/YAML.html +370 -0
  89. data/rdoc/site/0.2.0/Nucleon/Util.html +289 -0
  90. data/rdoc/site/0.2.0/Nucleon/Util/CLI.html +392 -0
  91. data/rdoc/site/0.2.0/Nucleon/Util/CLI/Parser.html +1250 -0
  92. data/rdoc/site/0.2.0/Nucleon/Util/Cache.html +784 -0
  93. data/rdoc/site/0.2.0/Nucleon/Util/Console.html +1318 -0
  94. data/rdoc/site/0.2.0/Nucleon/Util/Data.html +1411 -0
  95. data/rdoc/site/0.2.0/Nucleon/Util/Disk.html +526 -0
  96. data/rdoc/site/0.2.0/Nucleon/Util/Git.html +365 -0
  97. data/rdoc/site/0.2.0/Nucleon/Util/Liquid.html +369 -0
  98. data/rdoc/site/0.2.0/Nucleon/Util/Logger.html +810 -0
  99. data/rdoc/site/0.2.0/Nucleon/Util/Package.html +562 -0
  100. data/rdoc/site/0.2.0/Nucleon/Util/SSH.html +1033 -0
  101. data/rdoc/site/0.2.0/Nucleon/Util/SSH/Keypair.html +605 -0
  102. data/rdoc/site/0.2.0/Nucleon/Util/Shell.html +693 -0
  103. data/rdoc/site/0.2.0/Nucleon/Util/Shell/Result.html +501 -0
  104. data/rdoc/site/0.2.0/README_rdoc.html +316 -0
  105. data/rdoc/site/0.2.0/TODO_rdoc.html +265 -0
  106. data/rdoc/site/0.2.0/created.rid +61 -0
  107. data/rdoc/site/0.2.0/images/add.png +0 -0
  108. data/rdoc/site/0.2.0/images/brick.png +0 -0
  109. data/rdoc/site/0.2.0/images/brick_link.png +0 -0
  110. data/rdoc/site/0.2.0/images/bug.png +0 -0
  111. data/rdoc/site/0.2.0/images/bullet_black.png +0 -0
  112. data/rdoc/site/0.2.0/images/bullet_toggle_minus.png +0 -0
  113. data/rdoc/site/0.2.0/images/bullet_toggle_plus.png +0 -0
  114. data/rdoc/site/0.2.0/images/date.png +0 -0
  115. data/rdoc/site/0.2.0/images/delete.png +0 -0
  116. data/rdoc/site/0.2.0/images/find.png +0 -0
  117. data/rdoc/site/0.2.0/images/loadingAnimation.gif +0 -0
  118. data/rdoc/site/0.2.0/images/macFFBgHack.png +0 -0
  119. data/rdoc/site/0.2.0/images/package.png +0 -0
  120. data/rdoc/site/0.2.0/images/page_green.png +0 -0
  121. data/rdoc/site/0.2.0/images/page_white_text.png +0 -0
  122. data/rdoc/site/0.2.0/images/page_white_width.png +0 -0
  123. data/rdoc/site/0.2.0/images/plugin.png +0 -0
  124. data/rdoc/site/0.2.0/images/ruby.png +0 -0
  125. data/rdoc/site/0.2.0/images/tag_blue.png +0 -0
  126. data/rdoc/site/0.2.0/images/tag_green.png +0 -0
  127. data/rdoc/site/0.2.0/images/transparent.png +0 -0
  128. data/rdoc/site/0.2.0/images/wrench.png +0 -0
  129. data/rdoc/site/0.2.0/images/wrench_orange.png +0 -0
  130. data/rdoc/site/0.2.0/images/zoom.png +0 -0
  131. data/rdoc/site/0.2.0/index.html +315 -0
  132. data/rdoc/site/0.2.0/js/darkfish.js +155 -0
  133. data/rdoc/site/0.2.0/js/jquery.js +18 -0
  134. data/rdoc/site/0.2.0/js/navigation.js +142 -0
  135. data/rdoc/site/0.2.0/js/search.js +94 -0
  136. data/rdoc/site/0.2.0/js/search_index.js +1 -0
  137. data/rdoc/site/0.2.0/js/searcher.js +228 -0
  138. data/rdoc/site/0.2.0/rdoc.css +543 -0
  139. data/rdoc/site/0.2.0/table_of_contents.html +1657 -0
  140. data/spec/core/util/console_spec.rb +50 -18
  141. metadata +133 -2
data/rdoc/site/0.2.0/Nucleon/Util/SSH.html ADDED
@@ -0,0 +1,1033 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Nucleon::Util::SSH - nucleon 0.2.0</title>
8
+
9
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../../index.html">Home</a>
28
+ <a href="../../table_of_contents.html#classes">Classes</a>
29
+ <a href="../../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/core/util/ssh.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="../Core.html">Nucleon::Core</a>
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-close">::close</a>
74
+
75
+ <li><a href="#method-c-close_session">::close_session</a>
76
+
77
+ <li><a href="#method-c-download">::download</a>
78
+
79
+ <li><a href="#method-c-exec">::exec</a>
80
+
81
+ <li><a href="#method-c-generate">::generate</a>
82
+
83
+ <li><a href="#method-c-init_session">::init_session</a>
84
+
85
+ <li><a href="#method-c-key_path">::key_path</a>
86
+
87
+ <li><a href="#method-c-session">::session</a>
88
+
89
+ <li><a href="#method-c-session_id">::session_id</a>
90
+
91
+ <li><a href="#method-c-terminal">::terminal</a>
92
+
93
+ <li><a href="#method-c-unlock_private_key">::unlock_private_key</a>
94
+
95
+ <li><a href="#method-c-upload">::upload</a>
96
+
97
+ <li><a href="#method-c-valid-3F">::valid?</a>
98
+
99
+ </ul>
100
+ </nav>
101
+
102
+ </div>
103
+
104
+ <div id="project-metadata">
105
+ <nav id="fileindex-section" class="section project-section">
106
+ <h3 class="section-header">Pages</h3>
107
+
108
+ <ul>
109
+
110
+ <li class="file"><a href="../../ARCHITECTURE_rdoc.html">ARCHITECTURE</a>
111
+
112
+ <li class="file"><a href="../../README_rdoc.html">README</a>
113
+
114
+ <li class="file"><a href="../../TODO_rdoc.html">TODO</a>
115
+
116
+ </ul>
117
+ </nav>
118
+
119
+ <nav id="classindex-section" class="section project-section">
120
+ <h3 class="section-header">Class and Module Index</h3>
121
+
122
+ <ul class="link-list">
123
+
124
+ <li><a href="../../Nucleon.html">Nucleon</a>
125
+
126
+ <li><a href="../../Nucleon/Action.html">Nucleon::Action</a>
127
+
128
+ <li><a href="../../Nucleon/Action/Extract.html">Nucleon::Action::Extract</a>
129
+
130
+ <li><a href="../../Nucleon/Action/Project.html">Nucleon::Action::Project</a>
131
+
132
+ <li><a href="../../Nucleon/Action/Project/Add.html">Nucleon::Action::Project::Add</a>
133
+
134
+ <li><a href="../../Nucleon/Action/Project/Create.html">Nucleon::Action::Project::Create</a>
135
+
136
+ <li><a href="../../Nucleon/Action/Project/Remove.html">Nucleon::Action::Project::Remove</a>
137
+
138
+ <li><a href="../../Nucleon/Action/Project/Save.html">Nucleon::Action::Project::Save</a>
139
+
140
+ <li><a href="../../Nucleon/Action/Project/Update.html">Nucleon::Action::Project::Update</a>
141
+
142
+ <li><a href="../../Nucleon/Codes.html">Nucleon::Codes</a>
143
+
144
+ <li><a href="../../Nucleon/Command.html">Nucleon::Command</a>
145
+
146
+ <li><a href="../../Nucleon/Command/Bash.html">Nucleon::Command::Bash</a>
147
+
148
+ <li><a href="../../Nucleon/Config.html">Nucleon::Config</a>
149
+
150
+ <li><a href="../../Nucleon/Config/Collection.html">Nucleon::Config::Collection</a>
151
+
152
+ <li><a href="../../Nucleon/Config/Options.html">Nucleon::Config::Options</a>
153
+
154
+ <li><a href="../../Nucleon/Core.html">Nucleon::Core</a>
155
+
156
+ <li><a href="../../Nucleon/Environment.html">Nucleon::Environment</a>
157
+
158
+ <li><a href="../../Nucleon/Errors.html">Nucleon::Errors</a>
159
+
160
+ <li><a href="../../Nucleon/Errors/BatchError.html">Nucleon::Errors::BatchError</a>
161
+
162
+ <li><a href="../../Nucleon/Errors/NucleonError.html">Nucleon::Errors::NucleonError</a>
163
+
164
+ <li><a href="../../Nucleon/Errors/SSHUnavailable.html">Nucleon::Errors::SSHUnavailable</a>
165
+
166
+ <li><a href="../../Nucleon/Event.html">Nucleon::Event</a>
167
+
168
+ <li><a href="../../Nucleon/Event/Regex.html">Nucleon::Event::Regex</a>
169
+
170
+ <li><a href="../../Nucleon/Facade.html">Nucleon::Facade</a>
171
+
172
+ <li><a href="../../Nucleon/Gems.html">Nucleon::Gems</a>
173
+
174
+ <li><a href="../../Nucleon/Manager.html">Nucleon::Manager</a>
175
+
176
+ <li><a href="../../Nucleon/Mixin.html">Nucleon::Mixin</a>
177
+
178
+ <li><a href="../../Nucleon/Mixin/Action.html">Nucleon::Mixin::Action</a>
179
+
180
+ <li><a href="../../Nucleon/Mixin/Action/Commit.html">Nucleon::Mixin::Action::Commit</a>
181
+
182
+ <li><a href="../../Nucleon/Mixin/Action/Project.html">Nucleon::Mixin::Action::Project</a>
183
+
184
+ <li><a href="../../Nucleon/Mixin/Action/Push.html">Nucleon::Mixin::Action::Push</a>
185
+
186
+ <li><a href="../../Nucleon/Mixin/Colors.html">Nucleon::Mixin::Colors</a>
187
+
188
+ <li><a href="../../Nucleon/Mixin/ConfigCollection.html">Nucleon::Mixin::ConfigCollection</a>
189
+
190
+ <li><a href="../../Nucleon/Mixin/ConfigOptions.html">Nucleon::Mixin::ConfigOptions</a>
191
+
192
+ <li><a href="../../Nucleon/Mixin/Macro.html">Nucleon::Mixin::Macro</a>
193
+
194
+ <li><a href="../../Nucleon/Mixin/Macro/ObjectInterface.html">Nucleon::Mixin::Macro::ObjectInterface</a>
195
+
196
+ <li><a href="../../Nucleon/Mixin/Macro/PluginInterface.html">Nucleon::Mixin::Macro::PluginInterface</a>
197
+
198
+ <li><a href="../../Nucleon/Mixin/Settings.html">Nucleon::Mixin::Settings</a>
199
+
200
+ <li><a href="../../Nucleon/Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
201
+
202
+ <li><a href="../../Nucleon/Parallel.html">Nucleon::Parallel</a>
203
+
204
+ <li><a href="../../Nucleon/Parallel/ClassMethods.html">Nucleon::Parallel::ClassMethods</a>
205
+
206
+ <li><a href="../../Nucleon/Parallel/InstanceMethods.html">Nucleon::Parallel::InstanceMethods</a>
207
+
208
+ <li><a href="../../Nucleon/Plugin.html">Nucleon::Plugin</a>
209
+
210
+ <li><a href="../../Nucleon/Plugin/Action.html">Nucleon::Plugin::Action</a>
211
+
212
+ <li><a href="../../Nucleon/Plugin/Action/Option.html">Nucleon::Plugin::Action::Option</a>
213
+
214
+ <li><a href="../../Nucleon/Plugin/Base.html">Nucleon::Plugin::Base</a>
215
+
216
+ <li><a href="../../Nucleon/Plugin/Command.html">Nucleon::Plugin::Command</a>
217
+
218
+ <li><a href="../../Nucleon/Plugin/Event.html">Nucleon::Plugin::Event</a>
219
+
220
+ <li><a href="../../Nucleon/Plugin/Extension.html">Nucleon::Plugin::Extension</a>
221
+
222
+ <li><a href="../../Nucleon/Plugin/Project.html">Nucleon::Plugin::Project</a>
223
+
224
+ <li><a href="../../Nucleon/Plugin/Template.html">Nucleon::Plugin::Template</a>
225
+
226
+ <li><a href="../../Nucleon/Plugin/Translator.html">Nucleon::Plugin::Translator</a>
227
+
228
+ <li><a href="../../Nucleon/Project.html">Nucleon::Project</a>
229
+
230
+ <li><a href="../../Nucleon/Project/Git.html">Nucleon::Project::Git</a>
231
+
232
+ <li><a href="../../Nucleon/Project/Github.html">Nucleon::Project::Github</a>
233
+
234
+ <li><a href="../../Nucleon/Template.html">Nucleon::Template</a>
235
+
236
+ <li><a href="../../Nucleon/Template/JSON.html">Nucleon::Template::JSON</a>
237
+
238
+ <li><a href="../../Nucleon/Template/Wrapper.html">Nucleon::Template::Wrapper</a>
239
+
240
+ <li><a href="../../Nucleon/Template/YAML.html">Nucleon::Template::YAML</a>
241
+
242
+ <li><a href="../../Nucleon/Translator.html">Nucleon::Translator</a>
243
+
244
+ <li><a href="../../Nucleon/Translator/JSON.html">Nucleon::Translator::JSON</a>
245
+
246
+ <li><a href="../../Nucleon/Translator/YAML.html">Nucleon::Translator::YAML</a>
247
+
248
+ <li><a href="../../Nucleon/Util.html">Nucleon::Util</a>
249
+
250
+ <li><a href="../../Nucleon/Util/CLI.html">Nucleon::Util::CLI</a>
251
+
252
+ <li><a href="../../Nucleon/Util/CLI/Parser.html">Nucleon::Util::CLI::Parser</a>
253
+
254
+ <li><a href="../../Nucleon/Util/Cache.html">Nucleon::Util::Cache</a>
255
+
256
+ <li><a href="../../Nucleon/Util/Console.html">Nucleon::Util::Console</a>
257
+
258
+ <li><a href="../../Nucleon/Util/Data.html">Nucleon::Util::Data</a>
259
+
260
+ <li><a href="../../Nucleon/Util/Disk.html">Nucleon::Util::Disk</a>
261
+
262
+ <li><a href="../../Nucleon/Util/Git.html">Nucleon::Util::Git</a>
263
+
264
+ <li><a href="../../Nucleon/Util/Liquid.html">Nucleon::Util::Liquid</a>
265
+
266
+ <li><a href="../../Nucleon/Util/Logger.html">Nucleon::Util::Logger</a>
267
+
268
+ <li><a href="../../Nucleon/Util/Package.html">Nucleon::Util::Package</a>
269
+
270
+ <li><a href="../../Nucleon/Util/SSH.html">Nucleon::Util::SSH</a>
271
+
272
+ <li><a href="../../Nucleon/Util/SSH/Keypair.html">Nucleon::Util::SSH::Keypair</a>
273
+
274
+ <li><a href="../../Nucleon/Util/Shell.html">Nucleon::Util::Shell</a>
275
+
276
+ <li><a href="../../Nucleon/Util/Shell/Result.html">Nucleon::Util::Shell::Result</a>
277
+
278
+ <li><a href="../../Hash.html">Hash</a>
279
+
280
+ <li><a href="../../Kernel.html">Kernel</a>
281
+
282
+ </ul>
283
+ </nav>
284
+
285
+ </div>
286
+ </nav>
287
+
288
+ <div id="documentation">
289
+ <h1 class="class">class Nucleon::Util::SSH</h1>
290
+
291
+ <div id="description" class="description">
292
+
293
+ </div><!-- description -->
294
+
295
+
296
+
297
+
298
+ <section id="5Buntitled-5D" class="documentation-section">
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+ <!-- Methods -->
308
+
309
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
310
+ <h3 class="section-header">Public Class Methods</h3>
311
+
312
+
313
+ <div id="method-c-close" class="method-detail ">
314
+
315
+ <div class="method-heading">
316
+ <span class="method-name">close</span><span
317
+ class="method-args">(hostname = nil, user = nil)</span>
318
+ <span class="method-click-advice">click to toggle source</span>
319
+ </div>
320
+
321
+
322
+ <div class="method-description">
323
+
324
+
325
+
326
+
327
+
328
+ <div class="method-source-code" id="close-source">
329
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 209</span>
330
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">close</span>(<span class="ruby-identifier">hostname</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">user</span> = <span class="ruby-keyword">nil</span>)
331
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">hostname</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-comment"># Assume we entered a session id</span>
332
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">hostname</span>)
333
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">hostname</span>].<span class="ruby-identifier">close</span>
334
+ <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">hostname</span>)
335
+ <span class="ruby-keyword">end</span>
336
+
337
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">hostname</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">user</span> <span class="ruby-comment"># Generate session id from args</span>
338
+ <span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
339
+
340
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
341
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>].<span class="ruby-identifier">close</span>
342
+ <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>)
343
+ <span class="ruby-keyword">end</span>
344
+
345
+ <span class="ruby-keyword">else</span> <span class="ruby-comment"># Close all connections</span>
346
+ <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span>
347
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">id</span>].<span class="ruby-identifier">close</span>
348
+ <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
349
+ <span class="ruby-keyword">end</span>
350
+ <span class="ruby-keyword">end</span>
351
+ <span class="ruby-keyword">end</span></pre>
352
+ </div><!-- close-source -->
353
+
354
+ </div>
355
+
356
+
357
+
358
+
359
+ </div><!-- close-method -->
360
+
361
+
362
+ <div id="method-c-close_session" class="method-detail ">
363
+
364
+ <div class="method-heading">
365
+ <span class="method-name">close_session</span><span
366
+ class="method-args">(hostname, user)</span>
367
+ <span class="method-click-advice">click to toggle source</span>
368
+ </div>
369
+
370
+
371
+ <div class="method-description">
372
+
373
+
374
+
375
+
376
+
377
+ <div class="method-source-code" id="close_session-source">
378
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 195</span>
379
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">close_session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
380
+ <span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
381
+
382
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
383
+ <span class="ruby-keyword">begin</span> <span class="ruby-comment"># Don&#39;t care about errors here</span>
384
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>].<span class="ruby-identifier">close</span>
385
+ <span class="ruby-keyword">rescue</span>
386
+ <span class="ruby-keyword">end</span>
387
+ <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>)
388
+ <span class="ruby-keyword">end</span>
389
+ <span class="ruby-keyword">end</span></pre>
390
+ </div><!-- close_session-source -->
391
+
392
+ </div>
393
+
394
+
395
+
396
+
397
+ </div><!-- close_session-method -->
398
+
399
+
400
+ <div id="method-c-download" class="method-detail ">
401
+
402
+ <div class="method-heading">
403
+ <span class="method-name">download</span><span
404
+ class="method-args">(hostname, user, remote_path, local_path, options = {}) { |name, received, total| ... }</span>
405
+ <span class="method-click-advice">click to toggle source</span>
406
+ </div>
407
+
408
+
409
+ <div class="method-description">
410
+
411
+
412
+
413
+
414
+
415
+ <div class="method-source-code" id="download-source">
416
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 290</span>
417
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">options</span> = {})
418
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
419
+
420
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;net/scp&#39;</span>
421
+
422
+ <span class="ruby-comment"># Accepted options:</span>
423
+ <span class="ruby-comment"># * :recursive - the +remote+ parameter refers to a remote directory, which</span>
424
+ <span class="ruby-comment"># should be downloaded to a new directory named +local+ on the local</span>
425
+ <span class="ruby-comment"># machine.</span>
426
+ <span class="ruby-comment"># * :preserve - the atime and mtime of the file should be preserved.</span>
427
+ <span class="ruby-comment"># * :verbose - the process should result in verbose output on the server</span>
428
+ <span class="ruby-comment"># end (useful for debugging).</span>
429
+ <span class="ruby-comment">#</span>
430
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:recursive</span>, <span class="ruby-keyword">true</span>)
431
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:preserve</span>, <span class="ruby-keyword">true</span>)
432
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:verbose</span>, <span class="ruby-keyword">true</span>)
433
+
434
+ <span class="ruby-identifier">blocking</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:blocking</span>, <span class="ruby-keyword">true</span>)
435
+
436
+ <span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
437
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">blocking</span>
438
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download!</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">received</span>, <span class="ruby-identifier">total</span><span class="ruby-operator">|</span>
439
+ <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">received</span>, <span class="ruby-identifier">total</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
440
+ <span class="ruby-keyword">end</span>
441
+ <span class="ruby-keyword">else</span>
442
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>)
443
+ <span class="ruby-keyword">end</span>
444
+ <span class="ruby-keyword">end</span>
445
+ <span class="ruby-keyword">end</span></pre>
446
+ </div><!-- download-source -->
447
+
448
+ </div>
449
+
450
+
451
+
452
+
453
+ </div><!-- download-method -->
454
+
455
+
456
+ <div id="method-c-exec" class="method-detail ">
457
+
458
+ <div class="method-heading">
459
+ <span class="method-name">exec</span><span
460
+ class="method-args">(hostname, user, commands) { |:output, command, data| ... }</span>
461
+ <span class="method-click-advice">click to toggle source</span>
462
+ </div>
463
+
464
+
465
+ <div class="method-description">
466
+
467
+
468
+
469
+
470
+
471
+ <div class="method-source-code" id="exec-source">
472
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 234</span>
473
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">commands</span>)
474
+ <span class="ruby-identifier">results</span> = []
475
+
476
+ <span class="ruby-keyword">begin</span>
477
+ <span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
478
+ <span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">commands</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">command</span><span class="ruby-operator">|</span>
479
+ <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">command</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
480
+ <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">to_s</span>
481
+ <span class="ruby-identifier">result</span> = <span class="ruby-constant">Shell</span><span class="ruby-operator">::</span><span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">command</span>)
482
+
483
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">&quot;&gt;&gt; running SSH: #{command}&quot;</span>)
484
+
485
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">open_channel</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh_channel</span><span class="ruby-operator">|</span>
486
+ <span class="ruby-identifier">ssh_channel</span>.<span class="ruby-identifier">request_pty</span>
487
+ <span class="ruby-identifier">ssh_channel</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-identifier">command</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">channel</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
488
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">success</span>
489
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Could not execute command: #{command.inspect}&quot;</span>
490
+ <span class="ruby-keyword">end</span>
491
+
492
+ <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
493
+ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">append_output</span>(<span class="ruby-identifier">data</span>)
494
+ <span class="ruby-keyword">yield</span>(<span class="ruby-value">:output</span>, <span class="ruby-identifier">command</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
495
+ <span class="ruby-keyword">end</span>
496
+
497
+ <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_extended_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
498
+ <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
499
+ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">append_errors</span>(<span class="ruby-identifier">data</span>)
500
+ <span class="ruby-keyword">yield</span>(<span class="ruby-value">:error</span>, <span class="ruby-identifier">command</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
501
+ <span class="ruby-keyword">end</span>
502
+
503
+ <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_request</span>(<span class="ruby-string">&#39;exit-status&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
504
+ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">read_long</span>
505
+ <span class="ruby-keyword">end</span>
506
+
507
+ <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_request</span>(<span class="ruby-string">&#39;exit-signal&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
508
+ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">status</span> = <span class="ruby-value">255</span>
509
+ <span class="ruby-keyword">end</span>
510
+ <span class="ruby-keyword">end</span>
511
+ <span class="ruby-keyword">end</span>
512
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">&quot;`#{command}` messages: #{result.errors}&quot;</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">errors</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
513
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">&quot;`#{command}` status: #{result.status}&quot;</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
514
+
515
+ <span class="ruby-identifier">results</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">result</span>
516
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span>
517
+ <span class="ruby-keyword">end</span>
518
+ <span class="ruby-keyword">end</span>
519
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">HostKeyMismatch</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">error</span>
520
+ <span class="ruby-identifier">error</span>.<span class="ruby-identifier">remember_host!</span>
521
+ <span class="ruby-identifier">sleep</span> <span class="ruby-value">0.2</span>
522
+ <span class="ruby-keyword">retry</span>
523
+ <span class="ruby-keyword">end</span>
524
+ <span class="ruby-identifier">results</span>
525
+ <span class="ruby-keyword">end</span></pre>
526
+ </div><!-- exec-source -->
527
+
528
+ </div>
529
+
530
+
531
+
532
+
533
+ </div><!-- exec-method -->
534
+
535
+
536
+ <div id="method-c-generate" class="method-detail ">
537
+
538
+ <div class="method-heading">
539
+ <span class="method-name">generate</span><span
540
+ class="method-args">(options = {})</span>
541
+ <span class="method-click-advice">click to toggle source</span>
542
+ </div>
543
+
544
+
545
+ <div class="method-description">
546
+
547
+
548
+
549
+
550
+
551
+ <div class="method-source-code" id="generate-source">
552
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 26</span>
553
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">options</span> = {})
554
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
555
+
556
+ <span class="ruby-identifier">private_key</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:private_key</span>, <span class="ruby-keyword">nil</span>)
557
+ <span class="ruby-identifier">original_key</span> = <span class="ruby-keyword">nil</span>
558
+ <span class="ruby-identifier">key_comment</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:comment</span>, <span class="ruby-string">&#39;&#39;</span>)
559
+ <span class="ruby-identifier">passphrase</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:passphrase</span>, <span class="ruby-keyword">nil</span>)
560
+ <span class="ruby-identifier">force</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:force</span>, <span class="ruby-keyword">false</span>)
561
+
562
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>.<span class="ruby-identifier">nil?</span>
563
+ <span class="ruby-identifier">key_type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:type</span>, <span class="ruby-string">&quot;RSA&quot;</span>)
564
+ <span class="ruby-identifier">key_bits</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:bits</span>, <span class="ruby-value">2048</span>)
565
+
566
+ <span class="ruby-identifier">key_data</span> = <span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">generate</span>({
567
+ <span class="ruby-value">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key_type</span>,
568
+ <span class="ruby-value">:bits</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key_bits</span>,
569
+ <span class="ruby-value">:comment</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key_comment</span>,
570
+ <span class="ruby-value">:passphrase</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">passphrase</span>
571
+ })
572
+ <span class="ruby-identifier">is_new</span> = <span class="ruby-keyword">true</span>
573
+
574
+ <span class="ruby-keyword">else</span>
575
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">&#39;PRIVATE KEY&#39;</span>)
576
+ <span class="ruby-identifier">original_key</span> = <span class="ruby-identifier">private_key</span>
577
+ <span class="ruby-keyword">else</span>
578
+ <span class="ruby-identifier">original_key</span> = <span class="ruby-constant">Disk</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">private_key</span>)
579
+ <span class="ruby-keyword">end</span>
580
+
581
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">original_key</span>
582
+ <span class="ruby-identifier">encrypted</span> = <span class="ruby-identifier">original_key</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">&#39;ENCRYPTED&#39;</span>)
583
+ <span class="ruby-identifier">key_data</span> = <span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">original_key</span>, {
584
+ <span class="ruby-value">:comment</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key_comment</span>,
585
+ <span class="ruby-value">:passphrase</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">passphrase</span>
586
+ }) <span class="ruby-keyword">if</span> <span class="ruby-identifier">force</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">encrypted</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">passphrase</span>
587
+ <span class="ruby-keyword">end</span>
588
+ <span class="ruby-identifier">is_new</span> = <span class="ruby-keyword">false</span>
589
+ <span class="ruby-keyword">end</span>
590
+
591
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">key_data</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">key_data</span>.<span class="ruby-identifier">ssh_public_key</span>.<span class="ruby-identifier">empty?</span>
592
+ <span class="ruby-constant">Keypair</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key_data</span>, <span class="ruby-identifier">is_new</span>, <span class="ruby-identifier">original_key</span>, <span class="ruby-identifier">passphrase</span>)
593
+ <span class="ruby-keyword">end</span></pre>
594
+ </div><!-- generate-source -->
595
+
596
+ </div>
597
+
598
+
599
+
600
+
601
+ </div><!-- generate-method -->
602
+
603
+
604
+ <div id="method-c-init_session" class="method-detail ">
605
+
606
+ <div class="method-heading">
607
+ <span class="method-name">init_session</span><span
608
+ class="method-args">(hostname, user, port = 22, private_key = nil, options = {})</span>
609
+ <span class="method-click-advice">click to toggle source</span>
610
+ </div>
611
+
612
+
613
+ <div class="method-description">
614
+
615
+
616
+
617
+
618
+
619
+ <div class="method-source-code" id="init_session-source">
620
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 189</span>
621
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">init_session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span> = <span class="ruby-value">22</span>, <span class="ruby-identifier">private_key</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {})
622
+ <span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">private_key</span>, <span class="ruby-keyword">true</span>, <span class="ruby-identifier">options</span>)
623
+ <span class="ruby-keyword">end</span></pre>
624
+ </div><!-- init_session-source -->
625
+
626
+ </div>
627
+
628
+
629
+
630
+
631
+ </div><!-- init_session-method -->
632
+
633
+
634
+ <div id="method-c-key_path" class="method-detail ">
635
+
636
+ <div class="method-heading">
637
+ <span class="method-name">key_path</span><span
638
+ class="method-args">()</span>
639
+ <span class="method-click-advice">click to toggle source</span>
640
+ </div>
641
+
642
+
643
+ <div class="method-description">
644
+
645
+
646
+
647
+
648
+
649
+ <div class="method-source-code" id="key_path-source">
650
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 13</span>
651
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key_path</span>
652
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@key_path</span>
653
+ <span class="ruby-identifier">home_path</span> = ( <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;USER&#39;</span>] <span class="ruby-operator">==</span> <span class="ruby-string">&#39;root&#39;</span> <span class="ruby-operator">?</span> <span class="ruby-string">&#39;/root&#39;</span> <span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>] ) <span class="ruby-comment"># In case we are using sudo</span>
654
+ <span class="ruby-identifier">@@key_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">home_path</span>, <span class="ruby-string">&#39;.ssh&#39;</span>)
655
+
656
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">@@key_path</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">@@key_path</span>)
657
+ <span class="ruby-keyword">end</span>
658
+ <span class="ruby-identifier">@@key_path</span>
659
+ <span class="ruby-keyword">end</span></pre>
660
+ </div><!-- key_path-source -->
661
+
662
+ </div>
663
+
664
+
665
+
666
+
667
+ </div><!-- key_path-method -->
668
+
669
+
670
+ <div id="method-c-session" class="method-detail ">
671
+
672
+ <div class="method-heading">
673
+ <span class="method-name">session</span><span
674
+ class="method-args">(hostname, user, port = 22, private_key = nil, reset = false, options = {}) { |sessions| ... }</span>
675
+ <span class="method-click-advice">click to toggle source</span>
676
+ </div>
677
+
678
+
679
+ <div class="method-description">
680
+
681
+
682
+
683
+
684
+
685
+ <div class="method-source-code" id="session-source">
686
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 151</span>
687
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span> = <span class="ruby-value">22</span>, <span class="ruby-identifier">private_key</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reset</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">options</span> = {})
688
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;net/ssh&#39;</span>
689
+
690
+ <span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
691
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
692
+
693
+ <span class="ruby-identifier">ssh_options</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>({
694
+ <span class="ruby-value">:user_known_hosts_file</span> =<span class="ruby-operator">&gt;</span> [ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">key_path</span>, <span class="ruby-string">&#39;known_hosts&#39;</span>), <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">key_path</span>, <span class="ruby-string">&#39;known_hosts2&#39;</span>) ],
695
+ <span class="ruby-value">:auth_methods</span> =<span class="ruby-operator">&gt;</span> [ <span class="ruby-string">&#39;publickey&#39;</span> ],
696
+ <span class="ruby-value">:paranoid</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:very</span>
697
+ }).<span class="ruby-identifier">import</span>(<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">subset</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">keys</span> <span class="ruby-operator">-</span> [ <span class="ruby-value">:keypair</span>, <span class="ruby-value">:key_dir</span>, <span class="ruby-value">:key_name</span> ]))
698
+
699
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>
700
+ <span class="ruby-identifier">auth_id</span> = [ <span class="ruby-identifier">session_id</span>, <span class="ruby-identifier">private_key</span> ].<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;_&#39;</span>)
701
+
702
+ <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">unlock_private_key</span>(<span class="ruby-identifier">private_key</span>, <span class="ruby-identifier">config</span>)
703
+ <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>] = <span class="ruby-identifier">keypair</span>
704
+ <span class="ruby-keyword">end</span>
705
+ <span class="ruby-identifier">config</span>[<span class="ruby-value">:keypair</span>] = <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>] <span class="ruby-comment"># Reset so caller can access updated keypair </span>
706
+
707
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
708
+ <span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:keys_only</span>] = <span class="ruby-keyword">false</span>
709
+ <span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:keys</span>] = [ <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>] ]
710
+ <span class="ruby-keyword">else</span>
711
+ <span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:keys_only</span>] = <span class="ruby-keyword">true</span>
712
+ <span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:key_data</span>] = [ <span class="ruby-identifier">@@auth</span>[<span class="ruby-identifier">auth_id</span>].<span class="ruby-identifier">private_key</span> ]
713
+ <span class="ruby-keyword">end</span>
714
+ <span class="ruby-keyword">end</span>
715
+
716
+ <span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">port</span>
717
+
718
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">reset</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
719
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>] = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">ssh_options</span>.<span class="ruby-identifier">export</span>)
720
+ <span class="ruby-keyword">end</span>
721
+ <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]
722
+ <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]
723
+ <span class="ruby-keyword">end</span></pre>
724
+ </div><!-- session-source -->
725
+
726
+ </div>
727
+
728
+
729
+
730
+
731
+ </div><!-- session-method -->
732
+
733
+
734
+ <div id="method-c-session_id" class="method-detail ">
735
+
736
+ <div class="method-heading">
737
+ <span class="method-name">session_id</span><span
738
+ class="method-args">(hostname, user)</span>
739
+ <span class="method-click-advice">click to toggle source</span>
740
+ </div>
741
+
742
+
743
+ <div class="method-description">
744
+
745
+
746
+
747
+
748
+
749
+ <div class="method-source-code" id="session_id-source">
750
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 145</span>
751
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
752
+ <span class="ruby-node">&quot;#{hostname}-#{user}&quot;</span>
753
+ <span class="ruby-keyword">end</span></pre>
754
+ </div><!-- session_id-source -->
755
+
756
+ </div>
757
+
758
+
759
+
760
+
761
+ </div><!-- session_id-method -->
762
+
763
+
764
+ <div id="method-c-terminal" class="method-detail ">
765
+
766
+ <div class="method-heading">
767
+ <span class="method-name">terminal</span><span
768
+ class="method-args">(hostname, user, options = {})</span>
769
+ <span class="method-click-advice">click to toggle source</span>
770
+ </div>
771
+
772
+
773
+ <div class="method-description">
774
+
775
+ <p>Inspired by vagrant ssh implementation</p>
776
+
777
+ <p>See: <a
778
+ href="https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/ssh.rb">github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/ssh.rb</a></p>
779
+
780
+
781
+
782
+ <div class="method-source-code" id="terminal-source">
783
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 364</span>
784
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">terminal</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">options</span> = {})
785
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
786
+ <span class="ruby-identifier">ssh_path</span> = <span class="ruby-identifier">nucleon_locate</span>(<span class="ruby-string">&quot;ssh&quot;</span>)
787
+
788
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">SSHUnavailable</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ssh_path</span>
789
+
790
+ <span class="ruby-identifier">port</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:port</span>, <span class="ruby-value">22</span>)
791
+ <span class="ruby-identifier">private_keys</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:private_keys</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.ssh&#39;</span>, <span class="ruby-string">&#39;id_rsa&#39;</span>))
792
+
793
+ <span class="ruby-identifier">command_options</span> = [
794
+ <span class="ruby-node">&quot;#{user}@#{hostname}&quot;</span>,
795
+ <span class="ruby-string">&quot;-p&quot;</span>, <span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span>,
796
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;Compression=yes&quot;</span>,
797
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;DSAAuthentication=yes&quot;</span>,
798
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;LogLevel=FATAL&quot;</span>,
799
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;StrictHostKeyChecking=no&quot;</span>,
800
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;UserKnownHostsFile=/dev/null&quot;</span>,
801
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;IdentitiesOnly=yes&quot;</span>
802
+ ]
803
+
804
+ <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">private_keys</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
805
+ <span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">&quot;-i&quot;</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>) ]
806
+ <span class="ruby-keyword">end</span>
807
+
808
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:forward_x11</span>, <span class="ruby-keyword">false</span>)
809
+ <span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [
810
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;ForwardX11=yes&quot;</span>,
811
+ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;ForwardX11Trusted=yes&quot;</span>
812
+ ]
813
+ <span class="ruby-keyword">end</span>
814
+
815
+ <span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-node">&quot;ProxyCommand=#{config[:proxy_command]}&quot;</span> ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:proxy_command</span>, <span class="ruby-keyword">false</span>)
816
+ <span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">&quot;-o&quot;</span>, <span class="ruby-string">&quot;ForwardAgent=yes&quot;</span> ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:forward_agent</span>, <span class="ruby-keyword">false</span>)
817
+
818
+ <span class="ruby-identifier">command_options</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">config</span>[<span class="ruby-value">:extra_args</span>])) <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:extra_args</span>, <span class="ruby-keyword">false</span>)
819
+
820
+ <span class="ruby-comment">#---</span>
821
+
822
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">&quot;Executing SSH in subprocess: #{command_options.inspect}&quot;</span>)
823
+
824
+ <span class="ruby-identifier">process</span> = <span class="ruby-constant">ChildProcess</span>.<span class="ruby-identifier">build</span>(<span class="ruby-string">&#39;ssh&#39;</span>, *<span class="ruby-identifier">command_options</span>)
825
+ <span class="ruby-identifier">process</span>.<span class="ruby-identifier">io</span>.<span class="ruby-identifier">inherit!</span>
826
+
827
+ <span class="ruby-identifier">process</span>.<span class="ruby-identifier">start</span>
828
+ <span class="ruby-identifier">process</span>.<span class="ruby-identifier">wait</span>
829
+ <span class="ruby-identifier">process</span>.<span class="ruby-identifier">exit_code</span>
830
+ <span class="ruby-keyword">end</span></pre>
831
+ </div><!-- terminal-source -->
832
+
833
+ </div>
834
+
835
+
836
+
837
+
838
+ </div><!-- terminal-method -->
839
+
840
+
841
+ <div id="method-c-unlock_private_key" class="method-detail ">
842
+
843
+ <div class="method-heading">
844
+ <span class="method-name">unlock_private_key</span><span
845
+ class="method-args">(private_key, options = {})</span>
846
+ <span class="method-click-advice">click to toggle source</span>
847
+ </div>
848
+
849
+
850
+ <div class="method-description">
851
+
852
+
853
+
854
+
855
+
856
+ <div class="method-source-code" id="unlock_private_key-source">
857
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 415</span>
858
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">unlock_private_key</span>(<span class="ruby-identifier">private_key</span>, <span class="ruby-identifier">options</span> = {})
859
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;net/ssh&#39;</span>
860
+
861
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
862
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:keypair</span>, <span class="ruby-keyword">nil</span>)
863
+ <span class="ruby-identifier">key_dir</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:key_dir</span>, <span class="ruby-keyword">nil</span>)
864
+ <span class="ruby-identifier">key_name</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:key_name</span>, <span class="ruby-string">&#39;default&#39;</span>)
865
+ <span class="ruby-identifier">no_file</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;NUCLEON_NO_SSH_KEY_SAVE&#39;</span>]
866
+
867
+ <span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>
868
+ <span class="ruby-identifier">tmp_key_dir</span> = <span class="ruby-keyword">nil</span>
869
+
870
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>
871
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">keypair</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">keypair</span>.<span class="ruby-identifier">private_key</span>
872
+
873
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">no_file</span>
874
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">key_dir</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">key_name</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">private_key</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">loaded_private_key</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Disk</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">private_key</span>)
875
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">key_dir</span>)
876
+
877
+ <span class="ruby-identifier">loaded_private_key</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/BEGIN\s+([A-Z]+)\s+/</span>
878
+
879
+ <span class="ruby-identifier">local_key_type</span> = <span class="ruby-node">$1</span>
880
+ <span class="ruby-identifier">local_key_name</span> = <span class="ruby-constant">Keypair</span>.<span class="ruby-identifier">render</span>(<span class="ruby-identifier">local_key_type</span>, <span class="ruby-identifier">key_name</span>)
881
+ <span class="ruby-identifier">local_key_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">key_dir</span>, <span class="ruby-identifier">local_key_name</span>)
882
+
883
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">generate</span>({ <span class="ruby-value">:private_key</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">local_key_path</span> }) <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">local_key_path</span>)
884
+ <span class="ruby-keyword">end</span>
885
+ <span class="ruby-keyword">end</span>
886
+
887
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">keypair</span>
888
+ <span class="ruby-identifier">key_manager_logger</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">STDERR</span>)
889
+ <span class="ruby-identifier">key_manager_logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>
890
+ <span class="ruby-identifier">key_manager</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">Authentication</span><span class="ruby-operator">::</span><span class="ruby-constant">KeyManager</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key_manager_logger</span>)
891
+
892
+ <span class="ruby-identifier">key_manager</span>.<span class="ruby-identifier">each_identity</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">identity</span><span class="ruby-operator">|</span>
893
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">identity</span>.<span class="ruby-identifier">comment</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">private_key</span>
894
+ <span class="ruby-comment"># Feed the key to the system password manager if it exists</span>
895
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">private_key</span>
896
+ <span class="ruby-keyword">end</span>
897
+ <span class="ruby-keyword">end</span>
898
+ <span class="ruby-identifier">key_manager</span>.<span class="ruby-identifier">finish</span>
899
+
900
+ <span class="ruby-keyword">until</span> <span class="ruby-identifier">keypair</span>
901
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">generate</span>({
902
+ <span class="ruby-value">:private_key</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">private_key</span>,
903
+ <span class="ruby-value">:passphrase</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">password</span>
904
+ })
905
+ <span class="ruby-identifier">password</span> = <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">ask</span>(<span class="ruby-node">&quot;Enter passphrase for #{private_key}: &quot;</span>, { <span class="ruby-value">:echo</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">false</span> }) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">keypair</span>
906
+ <span class="ruby-keyword">end</span>
907
+
908
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">no_file</span>
909
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">key_dir</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">key_name</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">keypair</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
910
+ <span class="ruby-identifier">key_files</span> = <span class="ruby-identifier">keypair</span>.<span class="ruby-identifier">store</span>(<span class="ruby-identifier">key_dir</span>, <span class="ruby-identifier">key_name</span>, <span class="ruby-keyword">false</span>)
911
+
912
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">key_files</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">key_files</span>[<span class="ruby-value">:private_key</span>])
913
+ <span class="ruby-identifier">keypair</span> = <span class="ruby-identifier">generate</span>({ <span class="ruby-value">:private_key</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key_files</span>[<span class="ruby-value">:private_key</span>] })
914
+ <span class="ruby-keyword">end</span>
915
+ <span class="ruby-keyword">end</span>
916
+ <span class="ruby-keyword">end</span>
917
+ <span class="ruby-keyword">end</span>
918
+ <span class="ruby-keyword">end</span>
919
+ <span class="ruby-identifier">keypair</span>
920
+ <span class="ruby-keyword">end</span></pre>
921
+ </div><!-- unlock_private_key-source -->
922
+
923
+ </div>
924
+
925
+
926
+
927
+
928
+ </div><!-- unlock_private_key-method -->
929
+
930
+
931
+ <div id="method-c-upload" class="method-detail ">
932
+
933
+ <div class="method-heading">
934
+ <span class="method-name">upload</span><span
935
+ class="method-args">(hostname, user, local_path, remote_path, options = {}) { |name, sent, total| ... }</span>
936
+ <span class="method-click-advice">click to toggle source</span>
937
+ </div>
938
+
939
+
940
+ <div class="method-description">
941
+
942
+
943
+
944
+
945
+
946
+ <div class="method-source-code" id="upload-source">
947
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 322</span>
948
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">options</span> = {})
949
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
950
+
951
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;net/scp&#39;</span>
952
+
953
+ <span class="ruby-comment"># Accepted options:</span>
954
+ <span class="ruby-comment"># * :recursive - the +local+ parameter refers to a local directory, which</span>
955
+ <span class="ruby-comment"># should be uploaded to a new directory named +remote+ on the remote</span>
956
+ <span class="ruby-comment"># server.</span>
957
+ <span class="ruby-comment"># * :preserve - the atime and mtime of the file should be preserved.</span>
958
+ <span class="ruby-comment"># * :verbose - the process should result in verbose output on the server</span>
959
+ <span class="ruby-comment"># end (useful for debugging).</span>
960
+ <span class="ruby-comment"># * :chunk_size - the size of each &quot;chunk&quot; that should be sent. Defaults</span>
961
+ <span class="ruby-comment"># to 2048. Changing this value may improve throughput at the expense</span>
962
+ <span class="ruby-comment"># of decreasing interactivity.</span>
963
+ <span class="ruby-comment">#</span>
964
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:recursive</span>, <span class="ruby-keyword">true</span>)
965
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:preserve</span>, <span class="ruby-keyword">true</span>)
966
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:verbose</span>, <span class="ruby-keyword">true</span>)
967
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:chunk_size</span>, <span class="ruby-value">2048</span>)
968
+
969
+ <span class="ruby-identifier">blocking</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:blocking</span>, <span class="ruby-keyword">true</span>)
970
+
971
+ <span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
972
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">blocking</span>
973
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload!</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">sent</span>, <span class="ruby-identifier">total</span><span class="ruby-operator">|</span>
974
+ <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">sent</span>, <span class="ruby-identifier">total</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
975
+ <span class="ruby-keyword">end</span>
976
+ <span class="ruby-keyword">else</span>
977
+ <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>)
978
+ <span class="ruby-keyword">end</span>
979
+ <span class="ruby-keyword">end</span>
980
+ <span class="ruby-keyword">end</span></pre>
981
+ </div><!-- upload-source -->
982
+
983
+ </div>
984
+
985
+
986
+
987
+
988
+ </div><!-- upload-method -->
989
+
990
+
991
+ <div id="method-c-valid-3F" class="method-detail ">
992
+
993
+ <div class="method-heading">
994
+ <span class="method-name">valid?</span><span
995
+ class="method-args">(public_ssh_key)</span>
996
+ <span class="method-click-advice">click to toggle source</span>
997
+ </div>
998
+
999
+
1000
+ <div class="method-description">
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+ <div class="method-source-code" id="valid-3F-source">
1007
+ <pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 71</span>
1008
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">valid?</span>(<span class="ruby-identifier">public_ssh_key</span>)
1009
+ <span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">valid_ssh_public_key?</span>(<span class="ruby-identifier">public_ssh_key</span>)
1010
+ <span class="ruby-keyword">end</span></pre>
1011
+ </div><!-- valid-3F-source -->
1012
+
1013
+ </div>
1014
+
1015
+
1016
+
1017
+
1018
+ </div><!-- valid-3F-method -->
1019
+
1020
+
1021
+ </section><!-- public-class-method-details -->
1022
+
1023
+ </section><!-- 5Buntitled-5D -->
1024
+
1025
+ </div><!-- documentation -->
1026
+
1027
+
1028
+ <footer id="validator-badges">
1029
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
1030
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
1031
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
1032
+ </footer>
1033
+