<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.HTTP.Auth</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Network-HTTP-Auth.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Network-HTTP-Auth.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">HTTP-4000.1.1: A library for client-side HTTP</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable (not tested)</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Sigbjorn Finne <sigbjorn.finne@gmail.com></td></tr></table><p class="caption">Network.HTTP.Auth</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Representing HTTP Auth values in Haskell.
Right now, it contains mostly functionality needed by <code>Network.Browser</code>.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Authority">Authority</a> <ul class="subs"><li>= <a href="#v:AuthBasic">AuthBasic</a> { <ul class="subs"><li><a href="#v:auRealm">auRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auUsername">auUsername</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auPassword">auPassword</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auSite">auSite</a> :: <a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a></li></ul> }</li><li>| <a href="#v:AuthDigest">AuthDigest</a> { <ul class="subs"><li><a href="#v:auRealm">auRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auUsername">auUsername</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auPassword">auPassword</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auNonce">auNonce</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auAlgorithm">auAlgorithm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></li><li><a href="#v:auDomain">auDomain</a> :: [<a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a>]</li><li><a href="#v:auOpaque">auOpaque</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:auQop">auQop</a> :: [<a href="Network-HTTP-Auth.html#t:Qop">Qop</a>]</li></ul> }</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Algorithm">Algorithm</a> <ul class="subs"><li>= <a href="#v:AlgMD5">AlgMD5</a> </li><li>| <a href="#v:AlgMD5sess">AlgMD5sess</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Challenge">Challenge</a> <ul class="subs"><li>= <a href="#v:ChalBasic">ChalBasic</a> { <ul class="subs"><li><a href="#v:chRealm">chRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul> }</li><li>| <a href="#v:ChalDigest">ChalDigest</a> { <ul class="subs"><li><a href="#v:chRealm">chRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:chDomain">chDomain</a> :: [<a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a>]</li><li><a href="#v:chNonce">chNonce</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:chOpaque">chOpaque</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:chStale">chStale</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:chAlgorithm">chAlgorithm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></li><li><a href="#v:chQop">chQop</a> :: [<a href="Network-HTTP-Auth.html#t:Qop">Qop</a>]</li></ul> }</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Qop">Qop</a> <ul class="subs"><li>= <a href="#v:QopAuth">QopAuth</a> </li><li>| <a href="#v:QopAuthInt">QopAuthInt</a> </li></ul></li><li class="src short"><a href="#v:headerToChallenge">headerToChallenge</a> :: <a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a> -> <a href="Network-HTTP-Headers.html#t:Header">Header</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Challenge">Challenge</a></li><li class="src short"><a href="#v:withAuthority">withAuthority</a> :: <a href="Network-HTTP-Auth.html#t:Authority">Authority</a> -> <a href="Network-HTTP-Base.html#t:Request">Request</a> ty -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Authority" class="def">Authority</a> <a href="src/Network-HTTP-Auth.html#Authority" class="link">Source</a></p><div class="doc"><p><code>Authority</code> specifies the HTTP Authentication method to use for
a given domain/realm; <code>Basic</code> or <code>Digest</code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AuthBasic" class="def">AuthBasic</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:auRealm" class="def">auRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auUsername" class="def">auUsername</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auPassword" class="def">auPassword</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auSite" class="def">auSite</a> :: <a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr><tr><td class="src"><a name="v:AuthDigest" class="def">AuthDigest</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:auRealm" class="def">auRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auUsername" class="def">auUsername</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auPassword" class="def">auPassword</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auNonce" class="def">auNonce</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auAlgorithm" class="def">auAlgorithm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auDomain" class="def">auDomain</a> :: [<a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auOpaque" class="def">auOpaque</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:auQop" class="def">auQop</a> :: [<a href="Network-HTTP-Auth.html#t:Qop">Qop</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Algorithm" class="def">Algorithm</a> <a href="src/Network-HTTP-Auth.html#Algorithm" class="link">Source</a></p><div class="doc"><p><code>Algorithm</code> controls the digest algorithm to, <code>MD5</code> or <code>MD5Session</code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AlgMD5" class="def">AlgMD5</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:AlgMD5sess" class="def">AlgMD5sess</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Algorithm" class="caption collapser" onclick="toggleSection('i:Algorithm')">Instances</p><div id="section.i:Algorithm" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Challenge" class="def">Challenge</a> <a href="src/Network-HTTP-Auth.html#Challenge" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ChalBasic" class="def">ChalBasic</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:chRealm" class="def">chRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr><tr><td class="src"><a name="v:ChalDigest" class="def">ChalDigest</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:chRealm" class="def">chRealm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chDomain" class="def">chDomain</a> :: [<a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chNonce" class="def">chNonce</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chOpaque" class="def">chOpaque</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chStale" class="def">chStale</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chAlgorithm" class="def">chAlgorithm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Algorithm">Algorithm</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:chQop" class="def">chQop</a> :: [<a href="Network-HTTP-Auth.html#t:Qop">Qop</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Qop" class="def">Qop</a> <a href="src/Network-HTTP-Auth.html#Qop" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:QopAuth" class="def">QopAuth</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:QopAuthInt" class="def">QopAuthInt</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Qop" class="caption collapser" onclick="toggleSection('i:Qop')">Instances</p><div id="section.i:Qop" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Network-HTTP-Auth.html#t:Qop">Qop</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Network-HTTP-Auth.html#t:Qop">Qop</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:headerToChallenge" class="def">headerToChallenge</a> :: <a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-URI.html#t:URI">URI</a> -> <a href="Network-HTTP-Headers.html#t:Header">Header</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Challenge">Challenge</a><a href="src/Network-HTTP-Auth.html#headerToChallenge" class="link">Source</a></p><div class="doc"><p><code>headerToChallenge base www_auth</code> tries to convert the <code>WWW-Authenticate</code> header
<code>www_auth</code> into a <code><a href="Network-HTTP-Auth.html#t:Challenge">Challenge</a></code> value.
</p></div></div><div class="top"><p class="src"><a name="v:withAuthority" class="def">withAuthority</a> :: <a href="Network-HTTP-Auth.html#t:Authority">Authority</a> -> <a href="Network-HTTP-Base.html#t:Request">Request</a> ty -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Network-HTTP-Auth.html#withAuthority" class="link">Source</a></p><div class="doc"><p><code>withAuthority auth req</code> generates a credentials value from the <code>auth</code> <code><a href="Network-HTTP-Auth.html#t:Authority">Authority</a></code>,
in the context of the given request.
</p><p>If a client nonce was to be used then this function might need to be of type ... -> BrowserAction String
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
