c-ares/docs/ares_expand_name.3

.\"
.\" Copyright 1998 by the Massachusetts Institute of Technology.
.\" SPDX-License-Identifier: MIT
.\"
.TH ARES_EXPAND_NAME 3 "20 Nov 2009"
.SH NAME
ares_expand_name \- Expand a DNS-encoded domain name
.SH SYNOPSIS
.nf
#include <ares.h>

int ares_expand_name(const unsigned char *\fIencoded\fP,
                     const unsigned char *\fIabuf\fP, int \fIalen\fP,
                     char **\fIs\fP, long *\fIenclen\fP)
.fi
.SH DESCRIPTION
The
.B ares_expand_name
function converts a DNS-encoded domain name to a dot-separated C
string.  The argument
.I encoded
gives the beginning of the encoded domain name, and the arguments
.I abuf
and
.I alen
give the containing message buffer (necessary for the processing of
indirection pointers within the encoded domain name).  The result is
placed in a NUL-terminated allocated buffer, a pointer to which is
stored in the variable pointed to by
.IR s .
The length of the encoded name is stored in the variable pointed to by
.I enclen
so that the caller can advance past the encoded domain name to read
further data in the message.

Use \fIares_free_string(3)\fP to free the allocated hostname.
.SH RETURN VALUES
.B ares_expand_name
can return any of the following values:
.TP 15
.B ARES_SUCCESS
Expansion of the encoded name succeeded.
.TP 15
.B ARES_EBADNAME
The encoded domain name was malformed and could not be expanded.
.TP 15
.B ARES_ENOMEM
Memory was exhausted.
.SH SEE ALSO
.BR ares_mkquery (3),
.BR ares_free_string (3)
Avoid buffer overflow in RC4 loop comparison (#336) The rc4 function iterates over a buffer of size buffer_len who's maximum value is INT_MAX with a counter of type short that is not guaranteed to have maximum size INT_MAX. In circumstances where short is narrower than int and where buffer_len is larger than the maximum value of a short, it may be possible to loop infinitely as counter will overflow and never be greater than or equal to buffer_len. The solution is to make the comparison be between types of equal width. This commit defines counter as an int. Fix By: Fionn Fitzmaurice (@fionn) 4 years ago			`.\"`
			`.\" Copyright 1998 by the Massachusetts Institute of Technology.`
provide SPDX identifiers and a REUSE CI job to verify All files have their licence and copyright information clearly identifiable. If not in the file header, they are set separately in .reuse/dep5. All used license texts are provided in LICENSES/ 1 year ago			`.\" SPDX-License-Identifier: MIT`
			`.\"`
Avoid buffer overflow in RC4 loop comparison (#336) The rc4 function iterates over a buffer of size buffer_len who's maximum value is INT_MAX with a counter of type short that is not guaranteed to have maximum size INT_MAX. In circumstances where short is narrower than int and where buffer_len is larger than the maximum value of a short, it may be possible to loop infinitely as counter will overflow and never be greater than or equal to buffer_len. The solution is to make the comparison be between types of equal width. This commit defines counter as an int. Fix By: Fionn Fitzmaurice (@fionn) 4 years ago			`.TH ARES_EXPAND_NAME 3 "20 Nov 2009"`
			`.SH NAME`
			`ares_expand_name \- Expand a DNS-encoded domain name`
			`.SH SYNOPSIS`
			`.nf`
docs: reformat/cleanup man pages SYNOPSIS sections (#494) To make them render "nicer" in both terminals and on the website. - Removes the bold - Removes .PP lines - Indents them more like proper code style Fix By: Daniel Stenberg (@bagder) 2 years ago			`#include <ares.h>`

			`int ares_expand_name(const unsigned char *\fIencoded\fP,`
			`const unsigned char *\fIabuf\fP, int \fIalen\fP,`
			`char *\fIs\fP, long \fIenclen\fP)`
Avoid buffer overflow in RC4 loop comparison (#336) The rc4 function iterates over a buffer of size buffer_len who's maximum value is INT_MAX with a counter of type short that is not guaranteed to have maximum size INT_MAX. In circumstances where short is narrower than int and where buffer_len is larger than the maximum value of a short, it may be possible to loop infinitely as counter will overflow and never be greater than or equal to buffer_len. The solution is to make the comparison be between types of equal width. This commit defines counter as an int. Fix By: Fionn Fitzmaurice (@fionn) 4 years ago			`.fi`
			`.SH DESCRIPTION`
			`The`
			`.B ares_expand_name`
			`function converts a DNS-encoded domain name to a dot-separated C`
			`string. The argument`
			`.I encoded`
			`gives the beginning of the encoded domain name, and the arguments`
			`.I abuf`
			`and`
			`.I alen`
			`give the containing message buffer (necessary for the processing of`
			`indirection pointers within the encoded domain name). The result is`
			`placed in a NUL-terminated allocated buffer, a pointer to which is`
			`stored in the variable pointed to by`
			`.IR s .`
			`The length of the encoded name is stored in the variable pointed to by`
			`.I enclen`
			`so that the caller can advance past the encoded domain name to read`
			`further data in the message.`

			`Use \fIares_free_string(3)\fP to free the allocated hostname.`
			`.SH RETURN VALUES`
			`.B ares_expand_name`
			`can return any of the following values:`
			`.TP 15`
			`.B ARES_SUCCESS`
			`Expansion of the encoded name succeeded.`
			`.TP 15`
			`.B ARES_EBADNAME`
			`The encoded domain name was malformed and could not be expanded.`
			`.TP 15`
			`.B ARES_ENOMEM`
			`Memory was exhausted.`
			`.SH SEE ALSO`
docs: provide better man page references When referring to another c-ares function use \fI function(3) \fP to let the webpage rendering find and cross-link them appropriately. SEE ALSO references should be ".BR name (3),", with a space before the open parenthesis. This helps the manpage to HTML renderer. Closes #565 1 year ago			`.BR ares_mkquery (3),`
			`.BR ares_free_string (3)`