23s2s

✏️ Editing: AbstractHandler.html

<!DOCTYPE html>

<title>class Rack::Auth::AbstractHandler - 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">Object
  
</div>

<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-bad_request">#bad_request</a>
    
    <li ><a href="#method-i-unauthorized">#unauthorized</a>
    
  </ul>
</div>

</div>
</nav>

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

<section class="description">
    
<p><a href="AbstractHandler.html"><code>Rack::Auth::AbstractHandler</code></a> implements common authentication functionality.</p>

<p><code>realm</code> should be set for all handlers.</p>

</section>

<section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

<div id="attribute-i-realm" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">realm</span><span
            class="attribute-access-type">[RW]</span>
        </div>

<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">(app, realm = nil, &amp;authenticator)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">realm</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">authenticator</span>)
  <span class="ruby-ivar">@app</span>, <span class="ruby-ivar">@realm</span>, <span class="ruby-ivar">@authenticator</span> = <span class="ruby-identifier">app</span>, <span class="ruby-identifier">realm</span>, <span class="ruby-identifier">authenticator</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-bad_request" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">bad_request</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="bad_request-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bad_request</span>
  <span class="ruby-keyword">return</span> [ <span class="ruby-value">400</span>,
    { <span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;text/plain&#39;</span>,
      <span class="ruby-constant">CONTENT_LENGTH</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;0&#39;</span> },
    []
  ]
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

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

<div class="method-source-code" id="unauthorized-source">
            <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unauthorized</span>(<span class="ruby-identifier">www_authenticate</span> = <span class="ruby-identifier">challenge</span>)
  <span class="ruby-keyword">return</span> [ <span class="ruby-value">401</span>,
    { <span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;text/plain&#39;</span>,
      <span class="ruby-constant">CONTENT_LENGTH</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;0&#39;</span>,
      <span class="ruby-string">&#39;WWW-Authenticate&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">www_authenticate</span>.<span class="ruby-identifier">to_s</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