Mini Shell
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Auth::Digest::Nonce - rack-2.2.8 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">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-c-new">::new</a>
<li ><a href="#method-c-parse">::parse</a>
<li ><a href="#method-i-digest">#digest</a>
<li ><a href="#method-i-fresh-3F">#fresh?</a>
<li ><a href="#method-i-stale-3F">#stale?</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-valid-3F">#valid?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Auth::Digest::Nonce">
<h1 id="class-Rack::Auth::Digest::Nonce" class="class">
class Rack::Auth::Digest::Nonce
</h1>
<section class="description">
<p><a href="Nonce.html"><code>Rack::Auth::Digest::Nonce</code></a> is the default nonce generator for the <a href="MD5.html"><code>Rack::Auth::Digest::MD5</code></a> authentication handler.</p>
<p><code>private_key</code> needs to set to a constant string.</p>
<p><code>time_limit</code> can be optionally set to an integer (number of seconds), to limit the validity of the generated nonces.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-c-private_key" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">private_key</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-c-time_limit" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">time_limit</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</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">(timestamp = Time.now, given_digest = 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/rack/auth/digest/nonce.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">timestamp</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">given_digest</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@timestamp</span>, <span class="ruby-ivar">@given_digest</span> = <span class="ruby-identifier">timestamp</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">given_digest</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse</span><span
class="method-args">(string)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">string</span>)
<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">string</span>).<span class="ruby-identifier">split</span>(<span class="ruby-string">' '</span>, <span class="ruby-value">2</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-digest" class="method-detail ">
<div class="method-heading">
<span class="method-name">digest</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="digest-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">digest</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-node">"#{@timestamp}:#{self.class.private_key}"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fresh-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">fresh?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fresh-3F-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fresh?</span>
<span class="ruby-operator">!</span><span class="ruby-identifier">stale?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stale-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">stale?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="stale-3F-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stale?</span>
<span class="ruby-operator">!</span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">time_limit</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@timestamp</span>) <span class="ruby-operator">></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">time_limit</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-node">"#{@timestamp} #{digest}"</span>).<span class="ruby-identifier">strip</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-valid-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="valid-3F-source">
<pre><span class="ruby-comment"># File lib/rack/auth/digest/nonce.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid?</span>
<span class="ruby-identifier">digest</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@given_digest</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>
Zerion Mini Shell 1.0