File: C:/Ruby27-x64/share/doc/ruby/html/Net/IMAP/DigestMD5Authenticator.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::IMAP::DigestMD5Authenticator - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></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"><a href="../../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-nc">#nc</a>
<li ><a href="#method-i-process">#process</a>
<li ><a href="#method-i-qdval">#qdval</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::IMAP::DigestMD5Authenticator">
<h1 id="class-Net::IMAP::DigestMD5Authenticator" class="class">
class Net::IMAP::DigestMD5Authenticator
</h1>
<section class="description">
<p>Authenticator for the “DIGEST-MD5” authentication type. See authenticate().</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="STAGE_ONE">STAGE_ONE
<dd>
<dt id="STAGE_TWO">STAGE_TWO
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(user, password, authname = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 3646</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">authname</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@user</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-ivar">@authname</span> = <span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">authname</span>
<span class="ruby-ivar">@nc</span>, <span class="ruby-ivar">@stage</span> = {}, <span class="ruby-constant">STAGE_ONE</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-process" class="method-detail ">
<div class="method-heading">
<span class="method-name">process</span><span
class="method-args">(challenge)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="process-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 3581</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process</span>(<span class="ruby-identifier">challenge</span>)
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@stage</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">STAGE_ONE</span>
<span class="ruby-ivar">@stage</span> = <span class="ruby-constant">STAGE_TWO</span>
<span class="ruby-identifier">sparams</span> = {}
<span class="ruby-identifier">c</span> = <span class="ruby-constant">StringScanner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">challenge</span>)
<span class="ruby-keyword">while</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(?:\s*,)?\s*(\w+)=("(?:[^\\"]+|\\.)*"|[^,]+)\s*/</span>)
<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> = <span class="ruby-identifier">c</span>[<span class="ruby-value">1</span>], <span class="ruby-identifier">c</span>[<span class="ruby-value">2</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^"(.*)"$/</span>
<span class="ruby-identifier">v</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/,/</span>
<span class="ruby-identifier">v</span> = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">','</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sparams</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">DataFormatError</span>, <span class="ruby-node">"Bad Challenge: '#{challenge}'"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">rest</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Error</span>, <span class="ruby-node">"Server does not support auth (qop = #{sparams['qop'].join(',')})"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">sparams</span>[<span class="ruby-string">'qop'</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-string">"auth"</span>)
<span class="ruby-identifier">response</span> = {
<span class="ruby-value">:nonce</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">sparams</span>[<span class="ruby-string">'nonce'</span>],
<span class="ruby-value">:username</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@user</span>,
<span class="ruby-value">:realm</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">sparams</span>[<span class="ruby-string">'realm'</span>],
<span class="ruby-value">:cnonce</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">hexdigest</span>(<span class="ruby-string">"%.15f:%.15f:%d"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span>, <span class="ruby-identifier">rand</span>, <span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>.<span class="ruby-identifier">to_s</span>]),
<span class="ruby-value">:'digest-uri'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'imap/'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sparams</span>[<span class="ruby-string">'realm'</span>],
<span class="ruby-value">:qop</span> <span class="ruby-operator">=></span> <span class="ruby-string">'auth'</span>,
<span class="ruby-value">:maxbuf</span> <span class="ruby-operator">=></span> <span class="ruby-value">65535</span>,
<span class="ruby-value">:nc</span> <span class="ruby-operator">=></span> <span class="ruby-string">"%08d"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">nc</span>(<span class="ruby-identifier">sparams</span>[<span class="ruby-string">'nonce'</span>]),
<span class="ruby-value">:charset</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">sparams</span>[<span class="ruby-string">'charset'</span>],
}
<span class="ruby-identifier">response</span>[<span class="ruby-value">:authzid</span>] = <span class="ruby-ivar">@authname</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@authname</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-comment"># now, the real thing</span>
<span class="ruby-identifier">a0</span> = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">digest</span>( [ <span class="ruby-identifier">response</span>.<span class="ruby-identifier">values_at</span>(<span class="ruby-value">:username</span>, <span class="ruby-value">:realm</span>), <span class="ruby-ivar">@password</span> ].<span class="ruby-identifier">join</span>(<span class="ruby-string">':'</span>) )
<span class="ruby-identifier">a1</span> = [ <span class="ruby-identifier">a0</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">values_at</span>(<span class="ruby-value">:nonce</span>,<span class="ruby-value">:cnonce</span>) ].<span class="ruby-identifier">join</span>(<span class="ruby-string">':'</span>)
<span class="ruby-identifier">a1</span> <span class="ruby-operator"><<</span> <span class="ruby-string">':'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value">:authzid</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value">:authzid</span>].<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">a2</span> = <span class="ruby-string">"AUTHENTICATE:"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value">:'digest-uri'</span>]
<span class="ruby-identifier">a2</span> <span class="ruby-operator"><<</span> <span class="ruby-string">":00000000000000000000000000000000"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>[<span class="ruby-value">:qop</span>] <span class="ruby-keyword">and</span> <span class="ruby-identifier">response</span>[<span class="ruby-value">:qop</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^auth-(?:conf|int)$/</span>
<span class="ruby-identifier">response</span>[<span class="ruby-value">:response</span>] = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(
[
<span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">a1</span>),
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">values_at</span>(<span class="ruby-value">:nonce</span>, <span class="ruby-value">:nc</span>, <span class="ruby-value">:cnonce</span>, <span class="ruby-value">:qop</span>),
<span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">a2</span>)
].<span class="ruby-identifier">join</span>(<span class="ruby-string">':'</span>)
)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">qdval</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">response</span>[<span class="ruby-identifier">key</span>]) }.<span class="ruby-identifier">join</span>(<span class="ruby-string">','</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">STAGE_TWO</span>
<span class="ruby-ivar">@stage</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-comment"># if at the second stage, return an empty string</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">challenge</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/rspauth=/</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ResponseParseError</span>, <span class="ruby-identifier">challenge</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ResponseParseError</span>, <span class="ruby-identifier">challenge</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-nc" class="method-detail ">
<div class="method-heading">
<span class="method-name">nc</span><span
class="method-args">(nonce)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="nc-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 3656</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">nc</span>(<span class="ruby-identifier">nonce</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@nc</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">nonce</span>
<span class="ruby-ivar">@nc</span>[<span class="ruby-identifier">nonce</span>] = <span class="ruby-ivar">@nc</span>[<span class="ruby-identifier">nonce</span>] <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@nc</span>[<span class="ruby-identifier">nonce</span>] = <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@nc</span>[<span class="ruby-identifier">nonce</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-qdval" class="method-detail ">
<div class="method-heading">
<span class="method-name">qdval</span><span
class="method-args">(k, v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>some responses need quoting</p>
<div class="method-source-code" id="qdval-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 3666</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">qdval</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">if</span> <span class="ruby-node">%w"username authzid realm nonce cnonce digest-uri qop"</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">k</span>
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/([\\"])/</span>, <span class="ruby-string">"\\\1"</span>)
<span class="ruby-keyword">return</span> <span class="ruby-string">'%s="%s"'</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">'%s=%s'</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>