mirror of
https://github.com/opnsense/src.git
synced 2026-06-04 22:32:43 -04:00
c8759dc5fb
instead of accepting any character as a delimiter, only accept ':', '.'
and '-', and only permit a single delimiter in an address.
this prevents accepting bizarre addresses like:
ifconfig epair2a link 10.1.2.200/28
... which is particularly problematic on an INET6-only system, in which
case ifconfig defaults to the 'link' family, meaning that:
ifconfig epair2a 10.1.2.200/28
... changes the Ethernet address of the interface.
bump __FreeBSD_version so link_addr() consumers can detect the change.
Reviewed by: kp, des
Approved by: des (mentor)
Differential Revision: https://reviews.freebsd.org/D49936
(cherry picked from commit a121509041)
Note-from-OPNsense: not bumping the FreeBSD version for stable/25.7
180 lines
5.2 KiB
Groff
180 lines
5.2 KiB
Groff
.\" Copyright (c) 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Donn Seeley at BSDI.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" From: @(#)linkaddr.3 8.1 (Berkeley) 7/28/93
|
|
.\"
|
|
.Dd May 9, 2025
|
|
.Dt LINK_ADDR 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm link_addr ,
|
|
.Nm link_ntoa ,
|
|
.Nm link_ntoa_r
|
|
.Nd elementary address specification routines for link level access
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In sys/types.h
|
|
.In sys/socket.h
|
|
.In net/if_dl.h
|
|
.Ft int
|
|
.Fn link_addr "const char *addr" "struct sockaddr_dl *sdl"
|
|
.Ft char *
|
|
.Fn link_ntoa "const struct sockaddr_dl *sdl"
|
|
.Ft int
|
|
.Fn link_ntoa_r "const struct sockaddr_dl *sdl" "char *obuf" "size_t *buflen"
|
|
.Sh DESCRIPTION
|
|
The routine
|
|
.Fn link_addr
|
|
parses a character string
|
|
.Fa addr
|
|
representing a link-level address,
|
|
and stores the resulting address in the structure pointed to by
|
|
.Fa sdl .
|
|
A link-level address consists of an optional interface name, followed by
|
|
a colon (which is required in all cases), followed by an address
|
|
consisting of either a string of hexadecimal digits, or a series of
|
|
hexadecimal octets separated by one of the characters
|
|
.Sq "." ,
|
|
.Sq ":" ,
|
|
or
|
|
.Sq - .
|
|
.Pp
|
|
The routine
|
|
.Fn link_ntoa
|
|
takes
|
|
a link-level
|
|
address and returns an
|
|
.Tn ASCII
|
|
string representing some of the information present,
|
|
including the link level address itself, and the interface name
|
|
or number, if present.
|
|
The returned string is stored in a static buffer.
|
|
This facility is experimental and is
|
|
still subject to change.
|
|
.Pp
|
|
The routine
|
|
.Fn link_ntoa_r
|
|
behaves like
|
|
.Fn link_ntoa ,
|
|
except the string is placed in the provided buffer instead of a static
|
|
buffer.
|
|
The caller should initialize
|
|
.Fa buflen
|
|
to the number of bytes available in
|
|
.Fa obuf .
|
|
On return,
|
|
.Fa buflen
|
|
is set to the actual number of bytes required for the output buffer,
|
|
including the NUL terminator.
|
|
If
|
|
.Fa obuf
|
|
is NULL, then
|
|
.Fa buflen
|
|
is set as described, but nothing is written.
|
|
This may be used to determine the required length of the buffer before
|
|
calling
|
|
.Fn link_ntoa_r
|
|
a second time.
|
|
.Pp
|
|
For
|
|
.Fn link_addr ,
|
|
the string
|
|
.Fa addr
|
|
may contain
|
|
an optional network interface identifier of the form
|
|
.Dq "name unit-number" ,
|
|
suitable for the first argument to
|
|
.Xr ifconfig 8 ,
|
|
followed in all cases by a colon and
|
|
an interface address in the form of
|
|
groups of hexadecimal digits
|
|
separated by periods.
|
|
Each group represents a byte of address;
|
|
address bytes are filled left to right from
|
|
low order bytes through high order bytes.
|
|
.Pp
|
|
.\" A regular expression may make this format clearer:
|
|
.\" .Bd -literal -offset indent
|
|
.\" ([a-z]+[0-9]+:)?[0-9a-f]+(\e.[0-9a-f]+)*
|
|
.\" .Ed
|
|
.\" .Pp
|
|
Thus
|
|
.Li le0:8.0.9.13.d.30
|
|
represents an ethernet address
|
|
to be transmitted on the first Lance ethernet interface.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn link_ntoa
|
|
function
|
|
always returns a null terminated string.
|
|
.Pp
|
|
The
|
|
.Fn link_ntoa_r
|
|
function returns 0 on success, or -1 if the provided buffer was not
|
|
large enough; in the latter case, the contents of the buffer are
|
|
indeterminate, but a trailing NUL will always be written if the buffer
|
|
was at least one byte in size.
|
|
.Pp
|
|
The
|
|
.Fn link_addr
|
|
function returns 0 on success.
|
|
If the address did not appear to be a valid link-level address, -1 is
|
|
returned and
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh SEE ALSO
|
|
.Xr getnameinfo 3
|
|
.Sh HISTORY
|
|
The
|
|
.Fn link_addr
|
|
and
|
|
.Fn link_ntoa
|
|
functions appeared in
|
|
.Bx 4.3 Reno .
|
|
The
|
|
.Fn link_ntoa_r
|
|
function appeared in
|
|
.Fx 15.0 .
|
|
.Sh BUGS
|
|
The returned values for link_ntoa
|
|
reside in a static memory area.
|
|
.Pp
|
|
If the
|
|
.Va sdl_len
|
|
field of the link socket address
|
|
.Fa sdl
|
|
is 0,
|
|
.Fn link_ntoa
|
|
will not insert a colon before the interface address bytes.
|
|
If this translated address is given to
|
|
.Fn link_addr
|
|
without inserting an initial colon,
|
|
the latter will not interpret it correctly.
|