summaryrefslogtreecommitdiff
path: root/Net/SSH/Verifiers/Secure.html
blob: a4e9ae81373a04e2b1daa4a0ab0d4a92c951cd01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class Net::SSH::Verifiers::Secure - net-ssh 4.1.0</title>

<script type="text/javascript">
  var rdoc_rel_prefix = "../../../";
</script>

<script src="../../../js/jquery.js"></script>
<script src="../../../js/darkfish.js"></script>

<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">



<body id="top" role="document" class="class">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../../../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../../../table_of_contents.html#pages">Pages</a>
    <a href="../../../table_of_contents.html#classes">Classes</a>
    <a href="../../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  
  <p class="link">Object
  
</div>

    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-i-verify">#verify</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-Net::SSH::Verifiers::Secure">
  <h1 id="class-Net::SSH::Verifiers::Secure" class="class">
    class Net::SSH::Verifiers::Secure
  </h1>

  <section class="description">
    
<p>Does a strict host verification, looking the server up in the known host
files to see if a key has already been seen for this server. If this server
does not appear in any host file, an exception will be raised
(HostKeyUnknown). This is in contrast to the “Strict” class, which will
silently add the key to your known_hosts file. If the server does appear at
least once, but the key given does not match any known for the server, an
exception will be raised (HostKeyMismatch). Otherwise, this returns true.</p>

  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

    
      <div id="method-i-verify" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">verify</span><span
            class="method-args">(arguments)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="verify-source">
            <pre><span class="ruby-comment"># File lib/net/ssh/verifiers/secure.rb, line 15</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">verify</span>(<span class="ruby-identifier">arguments</span>)
  <span class="ruby-identifier">host_keys</span> = <span class="ruby-identifier">arguments</span>[<span class="ruby-value">:session</span>].<span class="ruby-identifier">host_keys</span>

  <span class="ruby-comment"># We&#39;ve never seen this host before, so raise an exception.</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">host_keys</span>.<span class="ruby-identifier">empty?</span>
    <span class="ruby-identifier">process_cache_miss</span>(<span class="ruby-identifier">host_keys</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-constant">HostKeyUnknown</span>, <span class="ruby-string">&quot;is unknown&quot;</span>)
  <span class="ruby-keyword">end</span>

  <span class="ruby-comment"># If we found any matches, check to see that the key type and</span>
  <span class="ruby-comment"># blob also match.</span>
  <span class="ruby-identifier">found</span> = <span class="ruby-identifier">host_keys</span>.<span class="ruby-identifier">any?</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">key</span>.<span class="ruby-identifier">ssh_type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">arguments</span>[<span class="ruby-value">:key</span>].<span class="ruby-identifier">ssh_type</span> <span class="ruby-operator">&amp;&amp;</span>
    <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_blob</span>  <span class="ruby-operator">==</span> <span class="ruby-identifier">arguments</span>[<span class="ruby-value">:key</span>].<span class="ruby-identifier">to_blob</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-comment"># If a match was found, return true. Otherwise, raise an exception</span>
  <span class="ruby-comment"># indicating that the key was not recognized.</span>
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">found</span>
    <span class="ruby-identifier">process_cache_miss</span>(<span class="ruby-identifier">host_keys</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-constant">HostKeyMismatch</span>, <span class="ruby-string">&quot;does not match&quot;</span>)
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">found</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>