lwres_resutil.html revision e3f6b4d2195b2fcd28f769452d460d1b35f1952a
2945N/A<!--
2945N/A - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
2945N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
2945N/A -
2945N/A - Permission to use, copy, modify, and distribute this software for any
2945N/A - purpose with or without fee is hereby granted, provided that the above
2945N/A - copyright notice and this permission notice appear in all copies.
2945N/A -
2945N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2945N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2945N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2945N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2945N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2945N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2945N/A - PERFORMANCE OF THIS SOFTWARE.
2945N/A-->
2945N/A<HTML
2945N/A><HEAD
2945N/A><TITLE
2945N/A>lwres_resutil</TITLE
2945N/A><META
2945N/ANAME="GENERATOR"
2945N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.73
2945N/A"></HEAD
2945N/A><BODY
4618N/ACLASS="REFENTRY"
5554N/ABGCOLOR="#FFFFFF"
2945N/ATEXT="#000000"
2945N/ALINK="#0000FF"
2945N/AVLINK="#840084"
2945N/AALINK="#0000FF"
2945N/A><H1
4618N/A><A
4618N/ANAME="AEN1"
4618N/A>lwres_resutil</A
4618N/A></H1
4618N/A><DIV
4618N/ACLASS="REFNAMEDIV"
4618N/A><A
4618N/ANAME="AEN8"
4618N/A></A
4618N/A><H2
4618N/A>Name</H2
4618N/A>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr&nbsp;--&nbsp;lightweight resolver utility functions</DIV
4618N/A><DIV
4618N/ACLASS="REFSYNOPSISDIV"
4618N/A><A
4618N/ANAME="AEN14"
2945N/A></A
4618N/A><H2
4618N/A>Synopsis</H2
4618N/A><DIV
4618N/ACLASS="FUNCSYNOPSIS"
4618N/A><A
4618N/ANAME="AEN15"
4618N/A></A
4618N/A><P
4618N/A></P
4618N/A><PRE
4618N/ACLASS="FUNCSYNOPSISINFO"
4618N/A>#include &lt;lwres/lwres.h&gt;</PRE
4618N/A><P
4618N/A><CODE
4618N/A><CODE
4618N/ACLASS="FUNCDEF"
4618N/A>lwres_result_t
4618N/Alwres_string_parse</CODE
4618N/A>(lwres_buffer_t *b, char **c, lwres_uint16_t *len);</CODE
4618N/A></P
4618N/A><P
4618N/A><CODE
4618N/A><CODE
4618N/ACLASS="FUNCDEF"
4618N/A>lwres_result_t
4618N/Alwres_addr_parse</CODE
4618N/A>(lwres_buffer_t *b, lwres_addr_t *addr);</CODE
4618N/A></P
4618N/A><P
4618N/A><CODE
4618N/A><CODE
4618N/ACLASS="FUNCDEF"
4618N/A>lwres_result_t
4618N/Alwres_getaddrsbyname</CODE
4618N/A>(lwres_context_t *ctx, const char *name, lwres_uint32_t addrtypes, lwres_gabnresponse_t **structp);</CODE
4618N/A></P
4865N/A><P
4618N/A><CODE
4618N/A><CODE
4618N/ACLASS="FUNCDEF"
4618N/A>lwres_result_t
4618N/Alwres_getnamebyaddr</CODE
5554N/A>(lwres_context_t *ctx, lwres_uint32_t addrtype, lwres_uint16_t addrlen, const unsigned char *addr, lwres_gnbaresponse_t **structp);</CODE
4618N/A></P
4618N/A><P
4618N/A></P
4618N/A></DIV
4618N/A></DIV
4618N/A><DIV
4618N/ACLASS="REFSECT1"
4618N/A><A
4618N/ANAME="AEN43"
4618N/A></A
4618N/A><H2
4618N/A>DESCRIPTION</H2
4618N/A><P
4618N/A><TT
4618N/ACLASS="FUNCTION"
4618N/A>lwres_string_parse()</TT
4618N/A> retrieves a DNS-encoded
4618N/Astring starting the current pointer of lightweight resolver buffer
4618N/A<TT
4618N/ACLASS="PARAMETER"
4618N/A><I
4618N/A>b</I
4618N/A></TT
4618N/A>: i.e. <TT
4618N/ACLASS="CONSTANT"
4618N/A>b-&gt;current</TT
4618N/A>.
4618N/AWhen the function returns, the address of the first byte of the
4618N/Aencoded string is returned via <TT
4618N/ACLASS="PARAMETER"
4618N/A><I
4618N/A>*c</I
4618N/A></TT
4618N/A> and the
4618N/Alength of that string is given by <TT
4618N/ACLASS="PARAMETER"
4618N/A><I
2945N/A>*len</I
2945N/A></TT
2945N/A>. The
2945N/Abuffer's current pointer is advanced to point at the character
following the string length, the encoded string, and the trailing
<SPAN
CLASS="TYPE"
>NULL</SPAN
> character.</P
><P
><TT
CLASS="FUNCTION"
>lwres_addr_parse()</TT
> extracts an address from the
buffer <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>. The buffer's current pointer
<TT
CLASS="CONSTANT"
>b-&gt;current</TT
> is presumed to point at an encoded
address: the address preceded by a 32-bit protocol family identifier
and a 16-bit length field. The encoded address is copied to
<TT
CLASS="CONSTANT"
>addr-&gt;address</TT
> and
<TT
CLASS="CONSTANT"
>addr-&gt;length</TT
> indicates the size in bytes of
the address that was copied. <TT
CLASS="CONSTANT"
>b-&gt;current</TT
> is
advanced to point at the next byte of available data in the buffer
following the encoded address.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
use the
<SPAN
CLASS="TYPE"
>lwres_gnbaresponse_t</SPAN
>
structure defined below:
<PRE
CLASS="PROGRAMLISTING"
>typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
lwres_uint16_t naddrs;
char *realname;
char **aliases;
lwres_uint16_t realnamelen;
lwres_uint16_t *aliaslen;
lwres_addrlist_t addrs;
void *base;
size_t baselen;
} lwres_gabnresponse_t;</PRE
>
The contents of this structure are not manipulated directly but
they are controlled through the
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_gabn</SPAN
>(3)</SPAN
>
functions.</P
><P
>The lightweight resolver uses
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
> to perform foward lookups.
Hostname <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> is looked up using the resolver
context <TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
> for memory allocation.
<TT
CLASS="PARAMETER"
><I
>addrtypes</I
></TT
> is a bitmask indicating which type of
addresses are to be looked up. Current values for this bitmask are
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V4</SPAN
> for IPv4 addresses and
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V6</SPAN
> for IPv6 addresses. Results of the
lookup are returned in <TT
CLASS="PARAMETER"
><I
>*structp</I
></TT
>.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
> performs reverse lookups.
Resolver context <TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
> is used for memory
allocation. The address type is indicated by
<TT
CLASS="PARAMETER"
><I
>addrtype</I
></TT
>: <SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V4</SPAN
> or
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V6</SPAN
>. The address to be looked up is given
by <TT
CLASS="PARAMETER"
><I
>addr</I
></TT
> and its length is
<TT
CLASS="PARAMETER"
><I
>addrlen</I
></TT
> bytes. The result of the function call
is made available through <TT
CLASS="PARAMETER"
><I
>*structp</I
></TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN84"
></A
><H2
>RETURN VALUES</H2
><P
>Successful calls to
<TT
CLASS="FUNCTION"
>lwres_string_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_addr_parse()</TT
>
return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS.</SPAN
>
Both functions return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_FAILURE</SPAN
>
if the buffer is corrupt or
<SPAN
CLASS="ERRORCODE"
>LWRES_R_UNEXPECTEDEND</SPAN
>
if the buffer has less space than expected for the components of the
encoded string or address.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
on success and it returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_NOTFOUND</SPAN
>
if the hostname
<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>
could not be found.</P
><P
><SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
is returned by a successful call to
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>.</P
><P
>Both
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_NOMEMORY</SPAN
>
when memory allocation requests fail and
<SPAN
CLASS="ERRORCODE"
>LWRES_R_UNEXPECTEDEND</SPAN
>
if the buffers used for sending queries and receiving replies are too
small.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN105"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_buffer</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_gabn</SPAN
>(3)</SPAN
>.</P
></DIV
></BODY
></HTML
>