103 lines
11 KiB
HTML
103 lines
11 KiB
HTML
<!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>Ldap.Asn1.FromAsn1</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_Ldap-Asn1-FromAsn1.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Ldap-Asn1-FromAsn1.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">ldap-client-0.1.0: Pure Haskell LDAP Client Library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Ldap.Asn1.FromAsn1</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module contains convertions from ASN.1 to LDAP types.</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"><a href="#v:parseAsn1">parseAsn1</a> :: <a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> a => [<a href="http://hackage.haskell.org/package/asn1-types/docs/Data-ASN1-Types.html#t:ASN1">ASN1</a>] -> <a href="http://hackage.haskell.org/package/base/docs/Data-Maybe.html#t:Maybe">Maybe</a> ([<a href="http://hackage.haskell.org/package/asn1-types/docs/Data-ASN1-Types.html#t:ASN1">ASN1</a>], a)</li><li class="src short"><span class="keyword">class</span> <a href="#t:FromAsn1">FromAsn1</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:parseAsn1" class="def">parseAsn1</a> :: <a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> a => [<a href="http://hackage.haskell.org/package/asn1-types/docs/Data-ASN1-Types.html#t:ASN1">ASN1</a>] -> <a href="http://hackage.haskell.org/package/base/docs/Data-Maybe.html#t:Maybe">Maybe</a> ([<a href="http://hackage.haskell.org/package/asn1-types/docs/Data-ASN1-Types.html#t:ASN1">ASN1</a>], a) <a href="src/Ldap-Asn1-FromAsn1.html#parseAsn1" class="link">Source</a></p><div class="doc"><p>Convert a part of ASN.1 stream to a LDAP type returning the remainder of the stream.</p></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:FromAsn1" class="def">FromAsn1</a> a <a href="src/Ldap-Asn1-FromAsn1.html#FromAsn1" class="link">Source</a></p><div class="doc"><p>ASN.1 stream parsers.</p><p>When it's relevant, instances include the part of RFC describing the encoding.</p></div><div class="subs minimal"><p class="caption">Minimal complete definition</p><p class="src">fromAsn1</p></div><div class="subs instances"><p id="control.i:FromAsn1" class="caption collapser" onclick="toggleSection('i:FromAsn1')">Instances</p><div id="section.i:FromAsn1" class="show"><table><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:LdapOid">LdapOid</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-89" class="link">Source</a></td><td class="doc"><pre>LDAPOID ::= OCTET STRING -- Constrained to <numericoid>
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:LdapString">LdapString</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-77" class="link">Source</a></td><td class="doc"><pre>LDAPString ::= OCTET STRING -- UTF-8 encoded,
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:Uri">Uri</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-267" class="link">Source</a></td><td class="doc"><pre>URI ::= LDAPString
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:ReferralUris">ReferralUris</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-255" class="link">Source</a></td><td class="doc"><pre>Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:LdapDn">LdapDn</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-101" class="link">Source</a></td><td class="doc"><pre>LDAPDN ::= LDAPString
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:PartialAttribute">PartialAttribute</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-129" class="link">Source</a></td><td class="doc"><pre>PartialAttribute ::= SEQUENCE {
|
|
type AttributeDescription,
|
|
vals SET OF value AttributeValue }
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:AttributeValue">AttributeValue</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-117" class="link">Source</a></td><td class="doc"><pre>AttributeValue ::= OCTET STRING
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:AttributeDescription">AttributeDescription</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-109" class="link">Source</a></td><td class="doc"><pre>AttributeDescription ::= LDAPString
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:LdapResult">LdapResult</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-195" class="link">Source</a></td><td class="doc"><pre>LDAPResult ::= SEQUENCE {
|
|
resultCode ENUMERATED {
|
|
success (0),
|
|
operationsError (1),
|
|
protocolError (2),
|
|
timeLimitExceeded (3),
|
|
sizeLimitExceeded (4),
|
|
compareFalse (5),
|
|
compareTrue (6),
|
|
authMethodNotSupported (7),
|
|
strongerAuthRequired (8),
|
|
-- 9 reserved --
|
|
referral (10),
|
|
adminLimitExceeded (11),
|
|
unavailableCriticalExtension (12),
|
|
confidentialityRequired (13),
|
|
saslBindInProgress (14),
|
|
noSuchAttribute (16),
|
|
undefinedAttributeType (17),
|
|
inappropriateMatching (18),
|
|
constraintViolation (19),
|
|
attributeOrValueExists (20),
|
|
invalidAttributeSyntax (21),
|
|
-- 22-31 unused --
|
|
noSuchObject (32),
|
|
aliasProblem (33),
|
|
invalidDNSyntax (34),
|
|
-- 35 reserved for undefined isLeaf --
|
|
aliasDereferencingProblem (36),
|
|
-- 37-47 unused --
|
|
inappropriateAuthentication (48),
|
|
invalidCredentials (49),
|
|
insufficientAccessRights (50),
|
|
busy (51),
|
|
unavailable (52),
|
|
unwillingToPerform (53),
|
|
loopDetect (54),
|
|
-- 55-63 unused --
|
|
namingViolation (64),
|
|
objectClassViolation (65),
|
|
notAllowedOnNonLeaf (66),
|
|
notAllowedOnRDN (67),
|
|
entryAlreadyExists (68),
|
|
objectClassModsProhibited (69),
|
|
-- 70 reserved for CLDAP --
|
|
affectsMultipleDSAs (71),
|
|
-- 72-79 unused --
|
|
other (80),
|
|
... },
|
|
matchedDN LDAPDN,
|
|
diagnosticMessage LDAPString,
|
|
referral [3] Referral OPTIONAL }
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:PartialAttributeList">PartialAttributeList</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-380" class="link">Source</a></td><td class="doc"><pre>PartialAttributeList ::= SEQUENCE OF partialAttribute PartialAttribute
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:ProtocolServerOp">ProtocolServerOp</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-325" class="link">Source</a></td><td class="doc"><pre>BindResponse ::= [APPLICATION 1] SEQUENCE {
|
|
COMPONENTS OF LDAPResult,
|
|
serverSaslCreds [7] OCTET STRING OPTIONAL }
|
|
</pre><pre>SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
|
|
objectName LDAPDN,
|
|
attributes PartialAttributeList }
|
|
</pre><pre>SearchResultReference ::= [APPLICATION 19] SEQUENCE
|
|
SIZE (1..MAX) OF uri URI
|
|
</pre><pre>SearchResultDone ::= [APPLICATION 5] LDAPResult
|
|
</pre><pre>ModifyResponse ::= [APPLICATION 7] LDAPResult
|
|
</pre><pre>AddResponse ::= [APPLICATION 9] LDAPResult
|
|
</pre><pre>DelResponse ::= [APPLICATION 11] LDAPResult
|
|
</pre><pre>ModifyDNResponse ::= [APPLICATION 13] LDAPResult
|
|
</pre><pre>CompareResponse ::= [APPLICATION 15] LDAPResult
|
|
</pre><pre>ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
|
|
COMPONENTS OF LDAPResult,
|
|
responseName [10] LDAPOID OPTIONAL,
|
|
responseValue [11] OCTET STRING OPTIONAL }
|
|
</pre><pre>IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
|
|
responseName [0] LDAPOID OPTIONAL,
|
|
responseValue [1] OCTET STRING OPTIONAL }
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> <a href="Ldap-Asn1-Type.html#t:Id">Id</a> <a href="src/Ldap-Asn1-FromAsn1.html#line-67" class="link">Source</a></td><td class="doc"><pre>MessageID ::= INTEGER (0 .. maxInt)
|
|
</pre></td></tr><tr><td class="src"><a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> op => <a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> (<a href="Ldap-Asn1-Type.html#t:LdapMessage">LdapMessage</a> op) <a href="src/Ldap-Asn1-FromAsn1.html#line-54" class="link">Source</a></td><td class="doc"><pre>LDAPMessage ::= SEQUENCE {
|
|
messageID MessageID,
|
|
protocolOp CHOICE {
|
|
bindRequest BindRequest,
|
|
bindResponse BindResponse,
|
|
unbindRequest UnbindRequest,
|
|
searchRequest SearchRequest,
|
|
searchResEntry SearchResultEntry,
|
|
searchResDone SearchResultDone,
|
|
searchResRef SearchResultReference,
|
|
addRequest AddRequest,
|
|
addResponse AddResponse,
|
|
... },
|
|
controls [0] Controls OPTIONAL }
|
|
</pre></td></tr><tr><td class="src">(<a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> a, <a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> b) => <a href="Ldap-Asn1-FromAsn1.html#t:FromAsn1">FromAsn1</a> (a, b) <a href="src/Ldap-Asn1-FromAsn1.html#line-387" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html> |