dnsruby 1.24 → 1.26

data/doc/classes/Dnsruby/RR/TSIG.html

@@ -92,7 +92,7 @@ coming from an approved recursive name server."
 A <a href="TSIG.html">Dnsruby::RR::TSIG</a> can represent the data present
 in a <a href="TSIG.html">TSIG</a> <a href="../RR.html">RR</a>. However, it
 can also represent the data (specified in RFC2845) used to sign or <a
-href="TSIG.html#M000070">verify</a> a <a href="../DNS.html">DNS</a>
+href="TSIG.html#M000423">verify</a> a <a href="../DNS.html">DNS</a>
 message.
 </p>
 <p>
@@ -126,15 +126,15 @@ Example code :
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000074">algorithm=</a>&nbsp;&nbsp;
-      <a href="#M000068">apply</a>&nbsp;&nbsp;
-      <a href="#M000069">calculate_mac</a>&nbsp;&nbsp;
-      <a href="#M000075">fudge=</a>&nbsp;&nbsp;
-      <a href="#M000072">init_defaults</a>&nbsp;&nbsp;
-      <a href="#M000073">name=</a>&nbsp;&nbsp;
-      <a href="#M000076">rdata_to_string</a>&nbsp;&nbsp;
-      <a href="#M000070">verify</a>&nbsp;&nbsp;
-      <a href="#M000071">verify_envelope</a>&nbsp;&nbsp;
+      <a href="#M000427">algorithm=</a>&nbsp;&nbsp;
+      <a href="#M000421">apply</a>&nbsp;&nbsp;
+      <a href="#M000422">calculate_mac</a>&nbsp;&nbsp;
+      <a href="#M000428">fudge=</a>&nbsp;&nbsp;
+      <a href="#M000425">init_defaults</a>&nbsp;&nbsp;
+      <a href="#M000426">name=</a>&nbsp;&nbsp;
+      <a href="#M000429">rdata_to_string</a>&nbsp;&nbsp;
+      <a href="#M000423">verify</a>&nbsp;&nbsp;
+      <a href="#M000424">verify_envelope</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -330,12 +330,12 @@ The default signing time is the current time.
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000074" class="method-detail">
-        <a name="M000074"></a>
+      <div id="method-M000427" class="method-detail">
+        <a name="M000427"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000074.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000074.html');return false;">
+          <a href="TSIG.src/M000427.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000427.html');return false;">
           <span class="method-name">algorithm=</span><span class="method-args">(alg)</span>
           </a>
         </div>
@@ -358,12 +358,12 @@ Set the algorithm to use to generate the HMAC Supported values are :
         </div>
       </div>
 
-      <div id="method-M000068" class="method-detail">
-        <a name="M000068"></a>
+      <div id="method-M000421" class="method-detail">
+        <a name="M000421"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000068.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000068.html');return false;">
+          <a href="TSIG.src/M000421.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000421.html');return false;">
           <span class="method-name">apply</span><span class="method-args">(message, original_request=nil)</span>
           </a>
         </div>
@@ -380,12 +380,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000069" class="method-detail">
-        <a name="M000069"></a>
+      <div id="method-M000422" class="method-detail">
+        <a name="M000422"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000069.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000069.html');return false;">
+          <a href="TSIG.src/M000422.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000422.html');return false;">
           <span class="method-name">calculate_mac</span><span class="method-args">(algorithm, data)</span>
           </a>
         </div>
@@ -394,12 +394,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000075" class="method-detail">
-        <a name="M000075"></a>
+      <div id="method-M000428" class="method-detail">
+        <a name="M000428"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000075.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000075.html');return false;">
+          <a href="TSIG.src/M000428.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000428.html');return false;">
           <span class="method-name">fudge=</span><span class="method-args">(f)</span>
           </a>
         </div>
@@ -408,12 +408,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000072" class="method-detail">
-        <a name="M000072"></a>
+      <div id="method-M000425" class="method-detail">
+        <a name="M000425"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000072.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000072.html');return false;">
+          <a href="TSIG.src/M000425.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000425.html');return false;">
           <span class="method-name">init_defaults</span><span class="method-args">()</span>
           </a>
         </div>
@@ -422,12 +422,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000073" class="method-detail">
-        <a name="M000073"></a>
+      <div id="method-M000426" class="method-detail">
+        <a name="M000426"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000073.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000073.html');return false;">
+          <a href="TSIG.src/M000426.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000426.html');return false;">
           <span class="method-name">name=</span><span class="method-args">(n)</span>
           </a>
         </div>
@@ -436,12 +436,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000076" class="method-detail">
-        <a name="M000076"></a>
+      <div id="method-M000429" class="method-detail">
+        <a name="M000429"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000076.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000076.html');return false;">
+          <a href="TSIG.src/M000429.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000429.html');return false;">
           <span class="method-name">rdata_to_string</span><span class="method-args">()</span>
           </a>
         </div>
@@ -450,12 +450,12 @@ Message#tsigstate will be set to :Signed.
         </div>
       </div>
 
-      <div id="method-M000070" class="method-detail">
-        <a name="M000070"></a>
+      <div id="method-M000423" class="method-detail">
+        <a name="M000423"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000070.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000070.html');return false;">
+          <a href="TSIG.src/M000423.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000423.html');return false;">
           <span class="method-name">verify</span><span class="method-args">(query, response, response_bytes, buf=&quot;&quot;)</span>
           </a>
         </div>
@@ -480,12 +480,12 @@ set to one of :
         </div>
       </div>
 
-      <div id="method-M000071" class="method-detail">
-        <a name="M000071"></a>
+      <div id="method-M000424" class="method-detail">
+        <a name="M000424"></a>
 
         <div class="method-heading">
-          <a href="TSIG.src/M000071.html" target="Code" class="method-signature"
-            onclick="popupCode('TSIG.src/M000071.html');return false;">
+          <a href="TSIG.src/M000424.html" target="Code" class="method-signature"
+            onclick="popupCode('TSIG.src/M000424.html');return false;">
           <span class="method-name">verify_envelope</span><span class="method-args">(response, response_bytes)</span>
           </a>
         </div>
@@ -501,7 +501,7 @@ href="TSIG.html">TSIG</a> is not present, and does not need to be present,
 then the message is added to the digest stream and the response#tsigstate
 is set to :Intermediate. If there is an error with the <a
 href="TSIG.html">TSIG</a> verification, then the response#tsigstate is set
-to :Failed. Like <a href="TSIG.html#M000070">verify</a>, this method will
+to :Failed. Like <a href="TSIG.html#M000423">verify</a>, this method will
 only be called by the <a
 href="../SingleResolver.html">Dnsruby::SingleResolver</a> class. Client
 code need not call this method directly.

data/doc/classes/Dnsruby/RR/TSIG.src/M000421.html

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>apply (Dnsruby::RR::TSIG)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/Dnsruby/resource/TSIG.rb, line 67</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">apply</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">original_request</span>=<span class="ruby-keyword kw">nil</span>)
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">message</span>.<span class="ruby-identifier">signed?</span>)
+          <span class="ruby-identifier">tsig_rr</span> = <span class="ruby-identifier">generate</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">original_request</span>)
+          <span class="ruby-identifier">message</span>.<span class="ruby-identifier">add_additional</span>(<span class="ruby-identifier">tsig_rr</span>)
+          <span class="ruby-identifier">message</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Signed</span>
+          <span class="ruby-ivar">@query</span> = <span class="ruby-identifier">message</span>
+          <span class="ruby-identifier">tsig_rr</span>.<span class="ruby-identifier">query</span> = <span class="ruby-identifier">message</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Dnsruby/RR/TSIG.src/M000422.html

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>calculate_mac (Dnsruby::RR::TSIG)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/Dnsruby/resource/TSIG.rb, line 143</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">calculate_mac</span>(<span class="ruby-identifier">algorithm</span>, <span class="ruby-identifier">data</span>)
+        <span class="ruby-identifier">mac</span>=<span class="ruby-keyword kw">nil</span>
+        <span class="ruby-identifier">key</span> = <span class="ruby-ivar">@key</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot;&quot;</span>)
+ <span class="ruby-comment cmt">#       key = Base64::decode64(key)</span>
+        <span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-value str">&quot;m*&quot;</span>)[<span class="ruby-value">0</span>]
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">algorithm</span> <span class="ruby-operator">==</span> <span class="ruby-constant">HMAC_MD5</span>)
+          <span class="ruby-identifier">mac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>)
+        <span class="ruby-keyword kw">elsif</span> (<span class="ruby-identifier">algorithm</span> <span class="ruby-operator">==</span> <span class="ruby-constant">HMAC_SHA1</span>)
+          <span class="ruby-identifier">mac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>)
+        <span class="ruby-keyword kw">elsif</span> (<span class="ruby-identifier">algorithm</span> <span class="ruby-operator">==</span> <span class="ruby-constant">HMAC_SHA256</span>)
+          <span class="ruby-identifier">mac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA256</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>)
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-comment cmt"># Should we allow client to pass in their own signing function?</span>
+          <span class="ruby-identifier">raise</span> <span class="ruby-constant">VerifyError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;Algorithm #{algorithm} unsupported by TSIG&quot;</span>)
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">mac</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Dnsruby/RR/TSIG.src/M000423.html

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>verify (Dnsruby::RR::TSIG)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/Dnsruby/resource/TSIG.rb, line 185</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">verify</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">response</span>, <span class="ruby-identifier">response_bytes</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-value str">&quot;&quot;</span>)
+        <span class="ruby-comment cmt">#        4.6. Client processing of answer</span>
+        <span class="ruby-comment cmt">#</span>
+        <span class="ruby-comment cmt">#   When a client receives a response from a server and expects to see a</span>
+        <span class="ruby-comment cmt">#   TSIG, it first checks if the TSIG RR is present in the response.</span>
+        <span class="ruby-comment cmt">#   Otherwise, the response is treated as having a format error and</span>
+        <span class="ruby-comment cmt">#   discarded.  The client then extracts the TSIG, adjusts the ARCOUNT,</span>
+        <span class="ruby-comment cmt">#   and calculates the keyed digest in the same way as the server.  If</span>
+        <span class="ruby-comment cmt">#   the TSIG does not validate, that response MUST be discarded, unless</span>
+        <span class="ruby-comment cmt">#   the RCODE is 9 (NOTAUTH), in which case the client SHOULD attempt to</span>
+        <span class="ruby-comment cmt">#   verify the response as if it were a TSIG Error response, as specified</span>
+        <span class="ruby-comment cmt">#   in [4.3].  A message containing an unsigned TSIG record or a TSIG</span>
+        <span class="ruby-comment cmt">#   record which fails verification SHOULD not be considered an</span>
+        <span class="ruby-comment cmt">#   acceptable response; the client SHOULD log an error and continue to</span>
+        <span class="ruby-comment cmt">#   wait for a signed response until the request times out.</span>
+
+        <span class="ruby-comment cmt"># So, this verify method should simply remove the TSIG RR and calculate</span>
+        <span class="ruby-comment cmt"># the MAC (using original request MAC if required).</span>
+        <span class="ruby-comment cmt"># Should set tsigstate on packet appropriately, and return error.</span>
+        <span class="ruby-comment cmt"># Side effect is packet is stripped of TSIG.</span>
+        <span class="ruby-comment cmt"># Resolver (or client) can then decide what to do...</span>
+
+        <span class="ruby-identifier">msg_tsig_rr</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsig</span>
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">verify_common</span>(<span class="ruby-identifier">response</span>))
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+        <span class="ruby-keyword kw">end</span>
+
+        <span class="ruby-identifier">new_msg_tsig_rr</span> = <span class="ruby-identifier">generate</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">query</span>, <span class="ruby-identifier">buf</span>, <span class="ruby-identifier">response_bytes</span>, <span class="ruby-identifier">msg_tsig_rr</span>)
+        
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">msg_tsig_rr</span>.<span class="ruby-identifier">mac</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">new_msg_tsig_rr</span>.<span class="ruby-identifier">mac</span>)
+          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Verified</span>
+          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigerror</span> = <span class="ruby-constant">RCode</span>.<span class="ruby-constant">NOERROR</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Failed</span>
+          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigerror</span> = <span class="ruby-constant">RCode</span>.<span class="ruby-constant">BADSIG</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Dnsruby/RR/TSIG.src/M000424.html

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>verify_envelope (Dnsruby::RR::TSIG)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/Dnsruby/resource/TSIG.rb, line 273</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">verify_envelope</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">response_bytes</span>)
+        <span class="ruby-comment cmt">#RFC2845 Section 4.4</span>
+        <span class="ruby-comment cmt">#-----</span>
+        <span class="ruby-comment cmt">#A DNS TCP session can include multiple DNS envelopes.  This is, for</span>
+        <span class="ruby-comment cmt">#example, commonly used by zone transfer.  Using TSIG on such a</span>
+        <span class="ruby-comment cmt">#connection can protect the connection from hijacking and provide data</span>
+        <span class="ruby-comment cmt">#integrity.  The TSIG MUST be included on the first and last DNS</span>
+        <span class="ruby-comment cmt">#envelopes.  It can be optionally placed on any intermediary</span>
+        <span class="ruby-comment cmt">#envelopes.  It is expensive to include it on every envelopes, but it</span>
+        <span class="ruby-comment cmt">#MUST be placed on at least every 100'th envelope.  The first envelope</span>
+        <span class="ruby-comment cmt">#is processed as a standard answer, and subsequent messages have the</span>
+        <span class="ruby-comment cmt">#following digest components:</span>
+        <span class="ruby-comment cmt">#</span>
+        <span class="ruby-comment cmt">#*   Prior Digest (running)</span>
+        <span class="ruby-comment cmt">#*   DNS Messages (any unsigned messages since the last TSIG)</span>
+        <span class="ruby-comment cmt">#*   TSIG Timers (current message)</span>
+        <span class="ruby-comment cmt">#</span>
+        <span class="ruby-comment cmt">#This allows the client to rapidly detect when the session has been</span>
+        <span class="ruby-comment cmt">#altered; at which point it can close the connection and retry.  If a</span>
+        <span class="ruby-comment cmt">#client TSIG verification fails, the client MUST close the connection.</span>
+        <span class="ruby-comment cmt">#If the client does not receive TSIG records frequently enough (as</span>
+        <span class="ruby-comment cmt">#specified above) it SHOULD assume the connection has been hijacked</span>
+        <span class="ruby-comment cmt">#and it SHOULD close the connection.  The client SHOULD treat this the</span>
+        <span class="ruby-comment cmt">#same way as they would any other interrupted transfer (although the</span>
+        <span class="ruby-comment cmt">#exact behavior is not specified).</span>
+        <span class="ruby-comment cmt">#-----</span>
+        <span class="ruby-comment cmt">#</span>
+        <span class="ruby-comment cmt"># Each time a new envelope comes in, this method is called on the QUERY TSIG RR.</span>
+        <span class="ruby-comment cmt"># It will set the response tsigstate to :Verified :Intermediate or :Failed</span>
+        <span class="ruby-comment cmt"># as appropriate.</span>
+        
+        <span class="ruby-comment cmt"># Keep digest going of messages as they come in (and mark them intermediate)</span>
+        <span class="ruby-comment cmt"># When TSIG comes in, work out what key should be and check. If OK, mark </span>
+        <span class="ruby-comment cmt"># verified. Can reset digest then.</span>
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-ivar">@buf</span>)
+          <span class="ruby-ivar">@num_envelopes</span> = <span class="ruby-value">0</span>
+          <span class="ruby-ivar">@last_signed</span> = <span class="ruby-value">0</span>
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-ivar">@num_envelopes</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsig</span>)
+          <span class="ruby-keyword kw">if</span> ((<span class="ruby-ivar">@num_envelopes</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-ivar">@num_envelopes</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@last_signed</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">100</span>))
+            <span class="ruby-constant">Dnsruby</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Receiving intermediate envelope in TSIG TCP session&quot;</span>)
+            <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Intermediate</span>
+            <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigerror</span> = <span class="ruby-constant">RCode</span>.<span class="ruby-constant">NOERROR</span>
+            <span class="ruby-ivar">@buf</span> = <span class="ruby-ivar">@buf</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response_bytes</span>
+            <span class="ruby-keyword kw">return</span>
+          <span class="ruby-keyword kw">else</span>
+            <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Failed</span>
+            <span class="ruby-constant">Dnsruby</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">&quot;Expecting signed packet&quot;</span>)
+            <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+          <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-ivar">@last_signed</span> = <span class="ruby-ivar">@num_envelopes</span>
+        
+        <span class="ruby-comment cmt"># We have a TSIG - process it!</span>
+        <span class="ruby-identifier">tsig</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsig</span>
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@num_envelopes</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>)
+          <span class="ruby-constant">Dnsruby</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;First response in TSIG TCP session - verifying normally&quot;</span>)
+          <span class="ruby-comment cmt"># Process it as a standard answer</span>
+          <span class="ruby-identifier">ok</span> = <span class="ruby-identifier">verify</span>(<span class="ruby-ivar">@query</span>, <span class="ruby-identifier">response</span>, <span class="ruby-identifier">response_bytes</span>)
+          <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">ok</span>)
+            <span class="ruby-identifier">mac_bytes</span> = <span class="ruby-constant">MessageEncoder</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
+              <span class="ruby-identifier">m</span>.<span class="ruby-identifier">put_pack</span>(<span class="ruby-value str">'n'</span>, <span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">mac_size</span>)
+              <span class="ruby-identifier">m</span>.<span class="ruby-identifier">put_bytes</span>(<span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">mac</span>)
+            }.<span class="ruby-identifier">to_s</span>
+            <span class="ruby-ivar">@buf</span> = <span class="ruby-identifier">mac_bytes</span>
+          <span class="ruby-keyword kw">else</span>
+          <span class="ruby-keyword kw">end</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ok</span>
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-constant">Dnsruby</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Processing TSIG on TSIG TCP session&quot;</span>)
+
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">verify_common</span>(<span class="ruby-identifier">response</span>))
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+        <span class="ruby-keyword kw">end</span>
+        
+        <span class="ruby-comment cmt"># Now add the current message data - remember to frig the arcount</span>
+        <span class="ruby-identifier">response_bytes</span> = <span class="ruby-constant">Header</span>.<span class="ruby-identifier">decrement_arcount_encoded</span>(<span class="ruby-identifier">response_bytes</span>)
+        <span class="ruby-ivar">@buf</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">response_bytes</span>[<span class="ruby-value">0</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstart</span>]
+        
+        <span class="ruby-comment cmt"># Let's add the timers</span>
+        <span class="ruby-identifier">timers_data</span> = <span class="ruby-constant">MessageEncoder</span>.<span class="ruby-identifier">new</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">msg</span><span class="ruby-operator">|</span>
+          <span class="ruby-identifier">time_high</span> = (<span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">time_signed</span> <span class="ruby-operator">&gt;&gt;</span> <span class="ruby-value">32</span>)
+          <span class="ruby-identifier">time_low</span> = (<span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">time_signed</span> <span class="ruby-operator">&amp;</span> <span class="ruby-value">0x</span><span class="ruby-constant">FFFFFFFF</span>)
+          <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">put_pack</span>(<span class="ruby-value str">'nN'</span>, <span class="ruby-identifier">time_high</span>, <span class="ruby-identifier">time_low</span>)
+          <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">put_pack</span>(<span class="ruby-value str">'n'</span>, <span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">fudge</span>)
+        }.<span class="ruby-identifier">to_s</span>
+        <span class="ruby-ivar">@buf</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">timers_data</span>
+        
+        <span class="ruby-identifier">mac</span> = <span class="ruby-identifier">calculate_mac</span>(<span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">algorithm</span>, <span class="ruby-ivar">@buf</span>)
+
+        <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">mac</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">tsig</span>.<span class="ruby-identifier">mac</span>)
+          <span class="ruby-constant">Dnsruby</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">&quot;TSIG Verify error on TSIG TCP session&quot;</span>)
+          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Failed</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-identifier">mac_bytes</span> = <span class="ruby-constant">MessageEncoder</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
+          <span class="ruby-identifier">m</span>.<span class="ruby-identifier">put_pack</span>(<span class="ruby-value str">'n'</span>, <span class="ruby-identifier">mac</span>.<span class="ruby-identifier">length</span>)
+          <span class="ruby-identifier">m</span>.<span class="ruby-identifier">put_bytes</span>(<span class="ruby-identifier">mac</span>)
+        }.<span class="ruby-identifier">to_s</span>
+        <span class="ruby-ivar">@buf</span>=<span class="ruby-identifier">mac_bytes</span>
+
+        <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigstate</span> = <span class="ruby-identifier">:Verified</span>
+        <span class="ruby-identifier">response</span>.<span class="ruby-identifier">tsigerror</span> = <span class="ruby-constant">RCode</span>.<span class="ruby-constant">NOERROR</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Dnsruby/RR/TSIG.src/M000425.html

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>init_defaults (Dnsruby::RR::TSIG)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/Dnsruby/resource/TSIG.rb, line 461</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">init_defaults</span>
+        <span class="ruby-comment cmt"># @TODO@ Have new() method which takes key_name and key?</span>
+        <span class="ruby-ivar">@algorithm</span>   = <span class="ruby-constant">DEFAULT_ALGORITHM</span>
+        <span class="ruby-ivar">@fudge</span>       = <span class="ruby-constant">DEFAULT_FUDGE</span>
+        <span class="ruby-ivar">@mac_size</span>    = <span class="ruby-value">0</span>
+        <span class="ruby-ivar">@mac</span>         = <span class="ruby-value str">&quot;&quot;</span>
+        <span class="ruby-ivar">@original_id</span> = <span class="ruby-identifier">rand</span>(<span class="ruby-value">65536</span>)
+        <span class="ruby-ivar">@error</span>       = <span class="ruby-value">0</span>
+        <span class="ruby-ivar">@other_size</span>   = <span class="ruby-value">0</span>
+        <span class="ruby-ivar">@other_data</span>  = <span class="ruby-value str">&quot;&quot;</span>
+        <span class="ruby-ivar">@time_signed</span> = <span class="ruby-keyword kw">nil</span>
+        <span class="ruby-ivar">@buf</span> = <span class="ruby-keyword kw">nil</span>
+        
+        <span class="ruby-comment cmt"># RFC 2845 Section 2.3</span>
+        <span class="ruby-ivar">@klass</span> = <span class="ruby-value str">&quot;ANY&quot;</span>
+        
+        <span class="ruby-ivar">@ttl</span> = <span class="ruby-value">0</span> <span class="ruby-comment cmt"># RFC 2845 Section 2.3</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>