115 lines
19 KiB
HTML
115 lines
19 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<head>
|
|
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
|
|
<title>src/Ldap/Client/Extended.hs</title>
|
|
<link type='text/css' rel='stylesheet' href='hscolour.css' />
|
|
</head>
|
|
<body>
|
|
<pre><a name="line-1"></a><span class='hs-comment'>-- | <https://tools.ietf.org/html/rfc4511#section-4.12 Extended> operation.</span>
|
|
<a name="line-2"></a><span class='hs-comment'>--</span>
|
|
<a name="line-3"></a><span class='hs-comment'>-- This operation comes in four flavours:</span>
|
|
<a name="line-4"></a><span class='hs-comment'>--</span>
|
|
<a name="line-5"></a><span class='hs-comment'>-- * synchronous, exception throwing ('extended')</span>
|
|
<a name="line-6"></a><span class='hs-comment'>--</span>
|
|
<a name="line-7"></a><span class='hs-comment'>-- * synchronous, returning 'Either' 'ResponseError' @()@ ('extendedEither')</span>
|
|
<a name="line-8"></a><span class='hs-comment'>--</span>
|
|
<a name="line-9"></a><span class='hs-comment'>-- * asynchronous, 'IO' based ('extendedAsync')</span>
|
|
<a name="line-10"></a><span class='hs-comment'>--</span>
|
|
<a name="line-11"></a><span class='hs-comment'>-- * asynchronous, 'STM' based ('extendedAsyncSTM')</span>
|
|
<a name="line-12"></a><span class='hs-comment'>--</span>
|
|
<a name="line-13"></a><span class='hs-comment'>-- Of those, the first one ('extended') is probably the most useful for the typical usecase.</span>
|
|
<a name="line-14"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Ldap</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Extended</span>
|
|
<a name="line-15"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Extended Operation</span>
|
|
<a name="line-16"></a> <span class='hs-conid'>Oid</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
|
|
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>extended</span>
|
|
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>extendedEither</span>
|
|
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>extendedAsync</span>
|
|
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>extendedAsyncSTM</span>
|
|
<a name="line-21"></a> <span class='hs-comment'>-- ** StartTLS Operation</span>
|
|
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>startTls</span>
|
|
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>startTlsEither</span>
|
|
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>startTlsAsync</span>
|
|
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>startTlsAsyncSTM</span>
|
|
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Async</span>
|
|
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>wait</span>
|
|
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>waitSTM</span>
|
|
<a name="line-29"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
|
|
<a name="line-30"></a>
|
|
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'><=<</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
|
|
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>STM</span> <span class='hs-layout'>(</span><span class='hs-conid'>STM</span><span class='hs-layout'>,</span> <span class='hs-varid'>atomically</span><span class='hs-layout'>)</span>
|
|
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
|
|
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span><span class='hs-varop'>.</span><span class='hs-conid'>NonEmpty</span> <span class='hs-layout'>(</span><span class='hs-conid'>NonEmpty</span><span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conop'>:|</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
|
|
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromString</span><span class='hs-layout'>)</span>
|
|
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-layout'>(</span><span class='hs-conid'>Text</span><span class='hs-layout'>)</span>
|
|
<a name="line-37"></a>
|
|
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Ldap</span><span class='hs-varop'>.</span><span class='hs-conid'>Asn1</span><span class='hs-varop'>.</span><span class='hs-conid'>Type</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Type</span>
|
|
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Ldap</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span>
|
|
<a name="line-40"></a>
|
|
<a name="line-41"></a>
|
|
<a name="line-42"></a><a name="Oid"></a><span class='hs-comment'>-- | Globally unique LDAP object identifier.</span>
|
|
<a name="line-43"></a><a name="Oid"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Oid</span> <span class='hs-conid'>Text</span>
|
|
<a name="line-44"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
|
|
<a name="line-45"></a>
|
|
<a name="line-46"></a><a name="extended"></a><span class='hs-comment'>-- | Perform the Extended operation synchronously. Raises 'ResponseError' on failures.</span>
|
|
<a name="line-47"></a><span class='hs-definition'>extended</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
|
|
<a name="line-48"></a><span class='hs-definition'>extended</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-49"></a> <span class='hs-varid'>raise</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>extendedEither</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span>
|
|
<a name="line-50"></a>
|
|
<a name="line-51"></a><a name="extendedEither"></a><span class='hs-comment'>-- | Perform the Extended operation synchronously. Returns @Left e@ where</span>
|
|
<a name="line-52"></a><span class='hs-comment'>-- @e@ is a 'ResponseError' on failures.</span>
|
|
<a name="line-53"></a><span class='hs-definition'>extendedEither</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Either</span> <span class='hs-conid'>ResponseError</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-54"></a><span class='hs-definition'>extendedEither</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-55"></a> <span class='hs-varid'>wait</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>extendedAsync</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span>
|
|
<a name="line-56"></a>
|
|
<a name="line-57"></a><a name="extendedAsync"></a><span class='hs-comment'>-- | Perform the Extended operation asynchronously. Call 'Ldap.Client.wait' to wait</span>
|
|
<a name="line-58"></a><span class='hs-comment'>-- for its completion.</span>
|
|
<a name="line-59"></a><span class='hs-definition'>extendedAsync</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Async</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-60"></a><span class='hs-definition'>extendedAsync</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-61"></a> <span class='hs-varid'>atomically</span> <span class='hs-layout'>(</span><span class='hs-varid'>extendedAsyncSTM</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span><span class='hs-layout'>)</span>
|
|
<a name="line-62"></a>
|
|
<a name="line-63"></a><a name="extendedAsyncSTM"></a><span class='hs-comment'>-- | Perform the Extended operation asynchronously.</span>
|
|
<a name="line-64"></a><span class='hs-comment'>--</span>
|
|
<a name="line-65"></a><span class='hs-comment'>-- Don't wait for its completion (with 'Ldap.Client.waitSTM') in the</span>
|
|
<a name="line-66"></a><span class='hs-comment'>-- same transaction you've performed it in.</span>
|
|
<a name="line-67"></a><span class='hs-definition'>extendedAsyncSTM</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>STM</span> <span class='hs-layout'>(</span><span class='hs-conid'>Async</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-68"></a><span class='hs-definition'>extendedAsyncSTM</span> <span class='hs-varid'>l</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-69"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>req</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>extendedRequest</span> <span class='hs-varid'>oid</span> <span class='hs-varid'>mv</span> <span class='hs-keyword'>in</span> <span class='hs-varid'>sendRequest</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-varid'>extendedResult</span> <span class='hs-varid'>req</span><span class='hs-layout'>)</span> <span class='hs-varid'>req</span>
|
|
<a name="line-70"></a>
|
|
<a name="line-71"></a><a name="extendedRequest"></a><span class='hs-definition'>extendedRequest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Oid</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Request</span>
|
|
<a name="line-72"></a><span class='hs-definition'>extendedRequest</span> <span class='hs-layout'>(</span><span class='hs-conid'>Oid</span> <span class='hs-varid'>oid</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-73"></a> <span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>ExtendedRequest</span> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>LdapOid</span> <span class='hs-varid'>oid</span><span class='hs-layout'>)</span>
|
|
<a name="line-74"></a>
|
|
<a name="line-75"></a><a name="extendedResult"></a><span class='hs-definition'>extendedResult</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Response</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>ResponseError</span> <span class='hs-conid'>()</span>
|
|
<a name="line-76"></a><span class='hs-definition'>extendedResult</span> <span class='hs-varid'>req</span> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>ExtendedResponse</span>
|
|
<a name="line-77"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>LdapResult</span> <span class='hs-varid'>code</span> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>LdapDn</span> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>LdapString</span> <span class='hs-varid'>dn</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
|
|
<a name="line-78"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>LdapString</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-conop'>:|</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
|
|
<a name="line-79"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Type</span><span class='hs-varop'>.</span><span class='hs-conid'>Success</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>code</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Right</span> <span class='hs-conid'>()</span>
|
|
<a name="line-80"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Left</span> <span class='hs-layout'>(</span><span class='hs-conid'>ResponseErrorCode</span> <span class='hs-varid'>req</span> <span class='hs-varid'>code</span> <span class='hs-layout'>(</span><span class='hs-conid'>Dn</span> <span class='hs-varid'>dn</span><span class='hs-layout'>)</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span>
|
|
<a name="line-81"></a><span class='hs-definition'>extendedResult</span> <span class='hs-varid'>req</span> <span class='hs-varid'>res</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Left</span> <span class='hs-layout'>(</span><span class='hs-conid'>ResponseInvalid</span> <span class='hs-varid'>req</span> <span class='hs-varid'>res</span><span class='hs-layout'>)</span>
|
|
<a name="line-82"></a>
|
|
<a name="line-83"></a>
|
|
<a name="line-84"></a><a name="startTls"></a><span class='hs-comment'>-- | An example of @Extended Operation@, cf. 'extended'.</span>
|
|
<a name="line-85"></a><span class='hs-definition'>startTls</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
|
|
<a name="line-86"></a><span class='hs-definition'>startTls</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-87"></a> <span class='hs-varid'>raise</span> <span class='hs-varop'><=<</span> <span class='hs-varid'>startTlsEither</span>
|
|
<a name="line-88"></a>
|
|
<a name="line-89"></a><a name="startTlsEither"></a><span class='hs-comment'>-- | An example of @Extended Operation@, cf. 'extendedEither'.</span>
|
|
<a name="line-90"></a><span class='hs-definition'>startTlsEither</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Either</span> <span class='hs-conid'>ResponseError</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-91"></a><span class='hs-definition'>startTlsEither</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-92"></a> <span class='hs-varid'>wait</span> <span class='hs-varop'><=<</span> <span class='hs-varid'>startTlsAsync</span>
|
|
<a name="line-93"></a>
|
|
<a name="line-94"></a><a name="startTlsAsync"></a><span class='hs-comment'>-- | An example of @Extended Operation@, cf. 'extendedAsync'.</span>
|
|
<a name="line-95"></a><span class='hs-definition'>startTlsAsync</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Async</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-96"></a><span class='hs-definition'>startTlsAsync</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-97"></a> <span class='hs-varid'>atomically</span> <span class='hs-varop'>.</span> <span class='hs-varid'>startTlsAsyncSTM</span>
|
|
<a name="line-98"></a>
|
|
<a name="line-99"></a><a name="startTlsAsyncSTM"></a><span class='hs-comment'>-- | An example of @Extended Operation@, cf. 'extendedAsyncSTM'.</span>
|
|
<a name="line-100"></a><span class='hs-definition'>startTlsAsyncSTM</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ldap</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>STM</span> <span class='hs-layout'>(</span><span class='hs-conid'>Async</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
|
|
<a name="line-101"></a><span class='hs-definition'>startTlsAsyncSTM</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>=</span>
|
|
<a name="line-102"></a> <span class='hs-varid'>extendedAsyncSTM</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-conid'>Oid</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromString</span> <span class='hs-str'>"1.3.6.1.4.1.1466.20037"</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
|
|
<a name="line-103"></a> <span class='hs-conid'>Nothing</span>
|
|
</pre></body>
|
|
</html>
|