Blame inet/inet6_opt.c

Packit Service 82fcde
/* Copyright (C) 2006-2018 Free Software Foundation, Inc.
Packit Service 82fcde
   This file is part of the GNU C Library.
Packit Service 82fcde
   Contributed by Ulrich Drepper <drepper@redhat.com>, 2006.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is free software; you can redistribute it and/or
Packit Service 82fcde
   modify it under the terms of the GNU Lesser General Public
Packit Service 82fcde
   License as published by the Free Software Foundation; either
Packit Service 82fcde
   version 2.1 of the License, or (at your option) any later version.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is distributed in the hope that it will be useful,
Packit Service 82fcde
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 82fcde
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 82fcde
   Lesser General Public License for more details.
Packit Service 82fcde
Packit Service 82fcde
   You should have received a copy of the GNU Lesser General Public
Packit Service 82fcde
   License along with the GNU C Library; if not, see
Packit Service 82fcde
   <http://www.gnu.org/licenses/>.  */
Packit Service 82fcde
Packit Service 82fcde
#include <string.h>
Packit Service 82fcde
#include <netinet/in.h>
Packit Service 82fcde
#include <netinet/ip6.h>
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.1
Packit Service 82fcde
Packit Service 82fcde
   This function returns the number of bytes needed for the empty
Packit Service 82fcde
   extension header i.e., without any options.  If EXTBUF is not NULL it
Packit Service 82fcde
   also initializes the extension header to have the correct length
Packit Service 82fcde
   field.  In that case if the EXTLEN value is not a positive (i.e.,
Packit Service 82fcde
   non-zero) multiple of 8 the function fails and returns -1.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_init (void *extbuf, socklen_t extlen)
Packit Service 82fcde
{
Packit Service 82fcde
  if (extbuf != NULL)
Packit Service 82fcde
    {
Packit Service 82fcde
      if (extlen <= 0 || (extlen % 8) != 0 || extlen > 256 * 8)
Packit Service 82fcde
	return -1;
Packit Service 82fcde
Packit Service 82fcde
      /* Fill in the length in units of 8 octets.  */
Packit Service 82fcde
      struct ip6_hbh *extp = (struct ip6_hbh *) extbuf;
Packit Service 82fcde
Packit Service 82fcde
      /* RFC 2460 requires that the header extension length is the
Packit Service 82fcde
	 length of the option header in 8-byte units, not including
Packit Service 82fcde
	 the first 8 bytes.  Hence we have to subtract one.  */
Packit Service 82fcde
      extp->ip6h_len = extlen / 8 - 1;
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  return sizeof (struct ip6_hbh);
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
static void
Packit Service 82fcde
add_padding (uint8_t *extbuf, int offset, int npad)
Packit Service 82fcde
{
Packit Service 82fcde
  if (npad == 1)
Packit Service 82fcde
    extbuf[offset] = IP6OPT_PAD1;
Packit Service 82fcde
  else if (npad > 0)
Packit Service 82fcde
    {
Packit Service 82fcde
      struct ip6_opt *pad_opt = (struct ip6_opt *) (extbuf + offset);
Packit Service 82fcde
Packit Service 82fcde
      pad_opt->ip6o_type = IP6OPT_PADN;
Packit Service 82fcde
      pad_opt->ip6o_len = npad - sizeof (struct ip6_opt);
Packit Service 82fcde
      /* Clear the memory used by the padding.  */
Packit Service 82fcde
      memset (pad_opt + 1, '\0', pad_opt->ip6o_len);
Packit Service 82fcde
    }
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.2
Packit Service 82fcde
Packit Service 82fcde
   This function returns the updated total length taking into account
Packit Service 82fcde
   adding an option with length 'len' and alignment 'align'.  If
Packit Service 82fcde
   EXTBUF is not NULL then, in addition to returning the length, the
Packit Service 82fcde
   function inserts any needed pad option, initializes the option
Packit Service 82fcde
   (setting the type and length fields) and returns a pointer to the
Packit Service 82fcde
   location for the option content in databufp.  If the option does
Packit Service 82fcde
   not fit in the extension header buffer the function returns -1.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_append (void *extbuf, socklen_t extlen, int offset, uint8_t type,
Packit Service 82fcde
		  socklen_t len, uint8_t align, void **databufp)
Packit Service 82fcde
{
Packit Service 82fcde
  /* Check minimum offset.  */
Packit Service 82fcde
  if (offset < sizeof (struct ip6_hbh))
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  /* One cannot add padding options.  */
Packit Service 82fcde
  if (type == IP6OPT_PAD1 || type == IP6OPT_PADN)
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  /* The option length must fit in one octet.  */
Packit Service 82fcde
  if (len > 255)
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  /* The alignment can only by 1, 2, 4, or 8 and must not exceed the
Packit Service 82fcde
     option length.  */
Packit Service 82fcde
  if (align == 0 || align > 8 || (align & (align - 1)) != 0 || align > len)
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  /* Determine the needed padding for alignment.  Following the
Packit Service 82fcde
     current content of the buffer we have the is the IPv6 option type
Packit Service 82fcde
     and length, followed immediately by the data.  The data has the
Packit Service 82fcde
     alignment constraints.  Therefore padding must be inserted in the
Packit Service 82fcde
     form of padding options before the new option. */
Packit Service 82fcde
  int data_offset = offset + sizeof (struct ip6_opt);
Packit Service 82fcde
  int npad = (align - data_offset % align) & (align - 1);
Packit Service 82fcde
Packit Service 82fcde
  if (extbuf != NULL)
Packit Service 82fcde
    {
Packit Service 82fcde
      /* Now we can check whether the buffer is large enough.  */
Packit Service 82fcde
      if (data_offset + npad + len > extlen)
Packit Service 82fcde
	return -1;
Packit Service 82fcde
Packit Service 82fcde
      add_padding (extbuf, offset, npad);
Packit Service 82fcde
Packit Service 82fcde
      offset += npad;
Packit Service 82fcde
Packit Service 82fcde
      /* Now prepare the option itself.  */
Packit Service 82fcde
      struct ip6_opt *opt = (struct ip6_opt *) ((uint8_t *) extbuf + offset);
Packit Service 82fcde
Packit Service 82fcde
      opt->ip6o_type = type;
Packit Service 82fcde
      opt->ip6o_len = len;
Packit Service 82fcde
Packit Service 82fcde
      *databufp = opt + 1;
Packit Service 82fcde
    }
Packit Service 82fcde
  else
Packit Service 82fcde
    offset += npad;
Packit Service 82fcde
Packit Service 82fcde
  return offset + sizeof (struct ip6_opt) + len;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.3
Packit Service 82fcde
Packit Service 82fcde
   This function returns the updated total length taking into account
Packit Service 82fcde
   the final padding of the extension header to make it a multiple of
Packit Service 82fcde
   8 bytes.  If EXTBUF is not NULL the function also initializes the
Packit Service 82fcde
   option by inserting a Pad1 or PadN option of the proper length.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_finish (void *extbuf, socklen_t extlen, int offset)
Packit Service 82fcde
{
Packit Service 82fcde
  /* Check minimum offset.  */
Packit Service 82fcde
  if (offset < sizeof (struct ip6_hbh))
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  /* Required padding at the end.  */
Packit Service 82fcde
  int npad = (8 - (offset & 7)) & 7;
Packit Service 82fcde
Packit Service 82fcde
  if (extbuf != NULL)
Packit Service 82fcde
    {
Packit Service 82fcde
      /* Make sure the buffer is large enough.  */
Packit Service 82fcde
      if (offset + npad > extlen)
Packit Service 82fcde
	return -1;
Packit Service 82fcde
Packit Service 82fcde
      add_padding (extbuf, offset, npad);
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  return offset + npad;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.4
Packit Service 82fcde
Packit Service 82fcde
   This function inserts data items of various sizes in the data
Packit Service 82fcde
   portion of the option.  VAL should point to the data to be
Packit Service 82fcde
   inserted.  OFFSET specifies where in the data portion of the option
Packit Service 82fcde
   the value should be inserted; the first byte after the option type
Packit Service 82fcde
   and length is accessed by specifying an offset of zero.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_set_val (void *databuf, int offset, void *val, socklen_t vallen)
Packit Service 82fcde
{
Packit Service 82fcde
  memcpy ((uint8_t *) databuf + offset, val, vallen);
Packit Service 82fcde
Packit Service 82fcde
  return offset + vallen;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.5
Packit Service 82fcde
Packit Service 82fcde
   This function parses received option extension headers returning
Packit Service 82fcde
   the next option.  EXTBUF and EXTLEN specifies the extension header.
Packit Service 82fcde
   OFFSET should either be zero (for the first option) or the length
Packit Service 82fcde
   returned by a previous call to 'inet6_opt_next' or
Packit Service 82fcde
   'inet6_opt_find'.  It specifies the position where to continue
Packit Service 82fcde
   scanning the extension buffer.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_next (void *extbuf, socklen_t extlen, int offset, uint8_t *typep,
Packit Service 82fcde
		socklen_t *lenp, void **databufp)
Packit Service 82fcde
{
Packit Service 82fcde
  if (offset == 0)
Packit Service 82fcde
    offset = sizeof (struct ip6_hbh);
Packit Service 82fcde
  else if (offset < sizeof (struct ip6_hbh))
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  while (offset < extlen)
Packit Service 82fcde
    {
Packit Service 82fcde
      struct ip6_opt *opt = (struct ip6_opt *) ((uint8_t *) extbuf + offset);
Packit Service 82fcde
Packit Service 82fcde
      if (opt->ip6o_type == IP6OPT_PAD1)
Packit Service 82fcde
	/* Single byte padding.  */
Packit Service 82fcde
	++offset;
Packit Service 82fcde
      else if (opt->ip6o_type == IP6OPT_PADN)
Packit Service 82fcde
	offset += sizeof (struct ip6_opt) + opt->ip6o_len;
Packit Service 82fcde
      else
Packit Service 82fcde
	{
Packit Service 82fcde
	  /* Check whether the option is valid.  */
Packit Service 82fcde
	  offset += sizeof (struct ip6_opt) + opt->ip6o_len;
Packit Service 82fcde
	  if (offset > extlen)
Packit Service 82fcde
	    return -1;
Packit Service 82fcde
Packit Service 82fcde
	  *typep = opt->ip6o_type;
Packit Service 82fcde
	  *lenp = opt->ip6o_len;
Packit Service 82fcde
	  *databufp = opt + 1;
Packit Service 82fcde
	  return offset;
Packit Service 82fcde
	}
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.6
Packit Service 82fcde
Packit Service 82fcde
   This function is similar to the previously described
Packit Service 82fcde
   'inet6_opt_next' function, except this function lets the caller
Packit Service 82fcde
   specify the option type to be searched for, instead of always
Packit Service 82fcde
   returning the next option in the extension header.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_find (void *extbuf, socklen_t extlen, int offset, uint8_t type,
Packit Service 82fcde
		socklen_t *lenp, void **databufp)
Packit Service 82fcde
{
Packit Service 82fcde
  if (offset == 0)
Packit Service 82fcde
    offset = sizeof (struct ip6_hbh);
Packit Service 82fcde
  else if (offset < sizeof (struct ip6_hbh))
Packit Service 82fcde
    return -1;
Packit Service 82fcde
Packit Service 82fcde
  while (offset < extlen)
Packit Service 82fcde
    {
Packit Service 82fcde
      struct ip6_opt *opt = (struct ip6_opt *) ((uint8_t *) extbuf + offset);
Packit Service 82fcde
Packit Service 82fcde
      if (opt->ip6o_type == IP6OPT_PAD1)
Packit Service 82fcde
	{
Packit Service 82fcde
	  /* Single byte padding.  */
Packit Service 82fcde
	  ++offset;
Packit Service 82fcde
	  if (type == IP6OPT_PAD1)
Packit Service 82fcde
	    {
Packit Service 82fcde
	      *lenp = 0;
Packit Service 82fcde
	      *databufp = (uint8_t *) extbuf + offset;
Packit Service 82fcde
	      return offset;
Packit Service 82fcde
	    }
Packit Service 82fcde
	}
Packit Service 82fcde
      else if (opt->ip6o_type != type)
Packit Service 82fcde
	offset += sizeof (struct ip6_opt) + opt->ip6o_len;
Packit Service 82fcde
      else
Packit Service 82fcde
	{
Packit Service 82fcde
	  /* Check whether the option is valid.  */
Packit Service 82fcde
	  offset += sizeof (struct ip6_opt) + opt->ip6o_len;
Packit Service 82fcde
	  if (offset > extlen)
Packit Service 82fcde
	    return -1;
Packit Service 82fcde
Packit Service 82fcde
	  *lenp = opt->ip6o_len;
Packit Service 82fcde
	  *databufp = opt + 1;
Packit Service 82fcde
	  return offset;
Packit Service 82fcde
	}
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* RFC 3542, 10.7
Packit Service 82fcde
Packit Service 82fcde
   This function extracts data items of various sizes in the data
Packit Service 82fcde
   portion of the option.  */
Packit Service 82fcde
int
Packit Service 82fcde
inet6_opt_get_val (void *databuf, int offset, void *val, socklen_t vallen)
Packit Service 82fcde
{
Packit Service 82fcde
  memcpy (val, (uint8_t *) databuf + offset, vallen);
Packit Service 82fcde
Packit Service 82fcde
  return offset + vallen;
Packit Service 82fcde
}