23s2s

✏️ Editing: Basic.html

<!DOCTYPE html>

<title>class Rack::Auth::Basic - rack-2.2.23 Documentation</title>

<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>

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

<p class="link"><a href="AbstractHandler.html">Rack::Auth::AbstractHandler</a>
  
</div>

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

<ul class="link-list" role="directory">
    
    <li ><a href="#method-i-call">#call</a>
    
    <li ><a href="#method-i-challenge">#challenge</a>
    
    <li ><a href="#method-i-valid-3F">#valid?</a>
    
  </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Rack::Auth::Basic">
  <h1 id="class-Rack::Auth::Basic" class="class">
    class Rack::Auth::Basic
  </h1>

<section class="description">
    
<p><a href="Basic.html"><code>Rack::Auth::Basic</code></a> implements HTTP <a href="Basic.html"><code>Basic</code></a> Authentication, as per RFC 2617.</p>

<p>Initialize with the <a href="../../Rack.html"><code>Rack</code></a> application that you want protecting, and a block that checks if a username and password pair are valid.</p>

<p>See also: <code>example/protectedlobster.rb</code></p>

</section>

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

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

<div class="method-source-code" id="call-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/basic.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call</span>(<span class="ruby-identifier">env</span>)
  <span class="ruby-identifier">auth</span> = <span class="ruby-constant">Basic</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">env</span>)

<span class="ruby-keyword">return</span> <span class="ruby-identifier">unauthorized</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">provided?</span>

<span class="ruby-keyword">return</span> <span class="ruby-identifier">bad_request</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">basic?</span>

<span class="ruby-keyword">if</span> <span class="ruby-identifier">valid?</span>(<span class="ruby-identifier">auth</span>)
    <span class="ruby-identifier">env</span>[<span class="ruby-string">&#39;REMOTE_USER&#39;</span>] = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">username</span>

<span class="ruby-keyword">return</span> <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
  <span class="ruby-keyword">end</span>

<span class="ruby-identifier">unauthorized</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-challenge" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">challenge</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="challenge-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/basic.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">challenge</span>
  <span class="ruby-string">&#39;Basic realm=&quot;%s&quot;&#39;</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">realm</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">(auth)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="valid-3F-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/basic.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid?</span>(<span class="ruby-identifier">auth</span>)
  <span class="ruby-ivar">@authenticator</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">auth</span>.<span class="ruby-identifier">credentials</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>

Sid Gifari From Gifari Industries - BD Cyber Security Team