From owner-svn-soc-all@freebsd.org  Mon Jun 29 19:47:42 2015
Return-Path: <owner-svn-soc-all@freebsd.org>
Delivered-To: svn-soc-all@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id A4E9D990241
 for <svn-soc-all@mailman.ysv.freebsd.org>;
 Mon, 29 Jun 2015 19:47:42 +0000 (UTC)
 (envelope-from roam@FreeBSD.org)
Received: from socsvn.freebsd.org (socsvn.freebsd.org
 [IPv6:2001:1900:2254:206a::50:2])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 969D91E0B
 for <svn-soc-all@FreeBSD.org>; Mon, 29 Jun 2015 19:47:42 +0000 (UTC)
 (envelope-from roam@FreeBSD.org)
Received: from socsvn.freebsd.org ([127.0.1.124])
 by socsvn.freebsd.org (8.14.9/8.14.9) with ESMTP id t5TJlgX3008577
 for <svn-soc-all@FreeBSD.org>; Mon, 29 Jun 2015 19:47:42 GMT
 (envelope-from roam@FreeBSD.org)
Received: (from www@localhost)
 by socsvn.freebsd.org (8.14.9/8.14.9/Submit) id t5TJlg1R008573
 for svn-soc-all@FreeBSD.org; Mon, 29 Jun 2015 19:47:42 GMT
 (envelope-from roam@FreeBSD.org)
Date: Mon, 29 Jun 2015 19:47:42 GMT
Message-Id: <201506291947.t5TJlg1R008573@socsvn.freebsd.org>
X-Authentication-Warning: socsvn.freebsd.org: www set sender to
 roam@FreeBSD.org using -f
From: roam@FreeBSD.org
To: svn-soc-all@FreeBSD.org
Subject: socsvn commit: r287742 - soc2015/roam/ng_ayiya
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-soc-all@freebsd.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: SVN commit messages for the entire Summer of Code repository
 <svn-soc-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-soc-all>,
 <mailto:svn-soc-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-soc-all/>
List-Post: <mailto:svn-soc-all@freebsd.org>
List-Help: <mailto:svn-soc-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-soc-all>,
 <mailto:svn-soc-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 29 Jun 2015 19:47:42 -0000

Author: roam
Date: Mon Jun 29 19:47:41 2015
New Revision: 287742
URL: http://svnweb.FreeBSD.org/socsvn/?view=rev&rev=287742

Log:
  Document data packets through the control hook.
  
  Add a note about the concept of forwarding all AYIYA packets that
  do not contain IPv6 forwarded data down the control hook, and
  signing and sending out all data packets coming in through the hook.
  
  ObQuote:	"I read the news today, oh boy"

Modified:
  soc2015/roam/ng_ayiya/ng_ayiya.4

Modified: soc2015/roam/ng_ayiya/ng_ayiya.4
==============================================================================
--- soc2015/roam/ng_ayiya/ng_ayiya.4	Mon Jun 29 19:47:37 2015	(r287741)
+++ soc2015/roam/ng_ayiya/ng_ayiya.4	Mon Jun 29 19:47:41 2015	(r287742)
@@ -160,7 +160,27 @@
 for the administrator's convenience; any text after the slash is
 ignored.
 .It Va control
-Control messages only, any data packets are ignored.
+A hook used by userland programs to initialize and control the
+.Tn AYIYA
+tunnel's operation.
+This hook is a suitable avenue for sending control messages to the
+.Nm ayiya
+node during its configuration.
+It also serves another purpose: all packets that arrive from the
+.Tn AYIYA
+peer and are not IPv6 forwarded data packets (opcode 1) are sent
+as data packets down the
+.Nm ayiya
+node's
+.Va control
+hook for the userland program to process.
+Similarly, all data packets coming in via the
+.Va control
+hook are signed with the
+.Tn AYIYA
+tunnel's secret hash and sent to the
+.Tn AYIYA
+peer.
 .It Va inet6
 The local IPv6 interface, a
 .Xr ng_iface 4