chiark - git - mdw - tripe/blob - tripe-protocol.h

   1 /* -*-c-*-
   2  *
   3  * $Id: tripe-protocol.h,v 1.2 2004/04/08 01:36:17 mdw Exp $
   4  *
   5  * Protocol definition for TrIPE
   6  *
   7  * (c) 2003 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Trivial IP Encryption (TrIPE).
  13  *
  14  * TrIPE is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * TrIPE is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with TrIPE; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef TRIPE_PROTOCOL_H
  30 #define TRIPE_PROTOCOL_H
  31
  32 /*----- TrIPE protocol ----------------------------------------------------*/
  33
  34 /* --- TrIPE message format --- *
  35  *
  36  * A packet begins with a single-byte message type.  The top four bits are a
  37  * category code used to send the message to the right general place in the
  38  * code; the bottom bits identify the actual message type.
  39  */
  40
  41 #define MSG_CATMASK 0xf0
  42 #define MSG_TYPEMASK 0x0f
  43
  44 /* --- Encrypted message packets --- *
  45  *
  46  * Messages of category @MSG_PACKET@ contain encrypted network packets.  The
  47  * message content is a symmetric-encrypted block (see below).  Reception of
  48  * a packet encrypted under a new key implicitly permits that key to be used
  49  * to send further packets.
  50  *
  51  * The only packet type accepted is zero.
  52  *
  53  * Packets may be encrypted under any live keyset, but should use the most
  54  * recent one.
  55  */
  56
  57 #define MSG_PACKET 0x00
  58
  59 /* --- Key exchange packets --- */
  60
  61 #define MSG_KEYEXCH 0x10
  62
  63 #define KX_PRECHAL 0u
  64 #define KX_COOKIE 1u
  65 #define KX_CHAL 2u
  66 #define KX_REPLY 3u
  67 #define KX_SWITCH 4u
  68 #define KX_SWITCHOK 5u
  69 #define KX_NMSG 6u
  70
  71 /* --- Symmetric encryption and keysets --- *
  72  *
  73  * Packets consist of an 80-bit MAC, a 32-bit sequence number, and the
  74  * encrypted payload.
  75  *
  76  * The plaintext is encrypted using Blowfish in CBC mode with ciphertext
  77  * stealing (as described in [Schneier].  The initialization vector is
  78  * selected randomly, and prepended to the actual ciphertext.
  79  *
  80  * The MAC is computed using the HMAC construction with RIPEMD160 over the
  81  * sequence number and the ciphertext (with IV); the first 80 bits of the
  82  * output are used.  (This is the minimum allowed by the draft FIPS for HMAC,
  83  * and the recommended truncation.)
  84  *
  85  * A keyset consists of
  86  *
  87  *   * an integrity (MAC) key;
  88  *   * a confidentiality (encryption) key; and
  89  *   * a sequence numbering space
  90  *
  91  * in each direction.  The packets sent by a host encrypted under a
  92  * particular keyset are assigned consecutive sequence numbers starting from
  93  * zero.  The receiving host must ensure that it only accepts each packet at
  94  * most once.  It should maintain a window of sequence numbers: packets with
  95  * numbers beyond the end of the window are accepted and cause the window to
  96  * be advanced; packets with numbers before the start of the window are
  97  * rejected; packets with numbers which appear within the window are accepted
  98  * only if the number has not been seen before.
  99  *
 100  * When a host sends a @KX_SWITCH@ or @KX_SWITCHOK@ message, it installs the
 101  * newly-negotiated keyset in a `listen-only' state: it may not send a packet
 102  * encrypted under the keyset until either it has received a @KX_SWITCH@ or
 103  * @KX_SWITCHOK@ message, or a @MSG_PACKET@ encrypted under the keyset, from
 104  * its peer.
 105  */
 106
 107 /*----- That's all, folks -------------------------------------------------*/
 108
 109 #endif