racoon.tproj/handler.h

   1 /*      $KAME: handler.h,v 1.44 2002/07/10 23:22:03 itojun Exp $        */
   2
   3 /*
   4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the project nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef __HANDLER_H__
  33 #define __HANDLER_H__
  34
  35 /* Phase 1 handler */
  36 /*
  37  * main mode:
  38  *      initiator               responder
  39  *  0   (---)                   (---)
  40  *  1   start                   start (1st msg received)
  41  *  2   (---)                   1st valid msg received
  42  *  3   1st msg sent            1st msg sent
  43  *  4   1st valid msg received  2st valid msg received
  44  *  5   2nd msg sent            2nd msg sent
  45  *  6   2nd valid msg received  3rd valid msg received
  46  *  7   3rd msg sent            3rd msg sent
  47  *  8   3rd valid msg received  (---)
  48  *  9   SA established          SA established
  49  *
  50  * aggressive mode:
  51  *      initiator               responder
  52  *  0   (---)                   (---)
  53  *  1   start                   start (1st msg received)
  54  *  2   (---)                   1st valid msg received
  55  *  3   1st msg sent            1st msg sent
  56  *  4   1st valid msg received  2st valid msg received
  57  *  5   (---)                   (---)
  58  *  6   (---)                   (---)
  59  *  7   (---)                   (---)
  60  *  8   (---)                   (---)
  61  *  9   SA established          SA established
  62  *
  63  * base mode:
  64  *      initiator               responder
  65  *  0   (---)                   (---)
  66  *  1   start                   start (1st msg received)
  67  *  2   (---)                   1st valid msg received
  68  *  3   1st msg sent            1st msg sent
  69  *  4   1st valid msg received  2st valid msg received
  70  *  5   2nd msg sent            (---)
  71  *  6   (---)                   (---)
  72  *  7   (---)                   (---)
  73  *  8   (---)                   (---)
  74  *  9   SA established          SA established
  75  */
  76 #define PHASE1ST_SPAWN                  0
  77 #define PHASE1ST_START                  1
  78 #define PHASE1ST_MSG1RECEIVED           2
  79 #define PHASE1ST_MSG1SENT               3
  80 #define PHASE1ST_MSG2RECEIVED           4
  81 #define PHASE1ST_MSG2SENT               5
  82 #define PHASE1ST_MSG3RECEIVED           6
  83 #define PHASE1ST_MSG3SENT               7
  84 #define PHASE1ST_MSG4RECEIVED           8
  85 #define PHASE1ST_ESTABLISHED            9
  86 #define PHASE1ST_EXPIRED                10
  87 #define PHASE1ST_MAX                    11
  88
  89 typedef enum {
  90         natt_remote_support     = 0x0001,
  91         natt_natd_received      = 0x0002,
  92         natt_no_remote_nat      = 0x0010,
  93         natt_no_local_nat       = 0x0020
  94 } natt_flags_t;
  95
  96 /* About address semantics in each case.
  97  *                      initiator(addr=I)       responder(addr=R)
  98  *                      src     dst             src     dst
  99  *                      (local) (remote)        (local) (remote)
 100  * phase 1 handler      I       R               R       I
 101  * phase 2 handler      I       R               R       I
 102  * getspi msg           R       I               I       R
 103  * acquire msg          I       R
 104  * ID payload           I       R               I       R
 105  */
 106 struct ph1handle {
 107         isakmp_index index;
 108
 109         int status;                     /* status of this SA */
 110         int side;                       /* INITIATOR or RESPONDER */
 111
 112         struct sockaddr *remote;        /* remote address to negosiate ph1 */
 113         struct sockaddr *local;         /* local address to negosiate ph1 */
 114                         /* XXX copy from rmconf due to anonymous configuration.
 115                          * If anonymous will be forbidden, we do delete them. */
 116
 117         struct remoteconf *rmconf;      /* pointer to remote configuration */
 118
 119         struct isakmpsa *approval;      /* pointer to SA(s) approved. */
 120         vchar_t *authstr;               /* place holder of string for auth. */
 121                                         /* for example pre-shared key */
 122
 123         u_int8_t version;               /* ISAKMP version */
 124         u_int8_t etype;                 /* Exchange type actually for use */
 125         u_int8_t flags;                 /* Flags */
 126         u_int32_t msgid;                /* message id */
 127
 128         struct sched *sce;              /* schedule for expire */
 129
 130         struct sched *scr;              /* schedule for resend */
 131         int retry_counter;              /* for resend. */
 132         vchar_t *sendbuf;               /* buffer for re-sending */
 133
 134         vchar_t *dhpriv;                /* DH; private value */
 135         vchar_t *dhpub;                 /* DH; public value */
 136         vchar_t *dhpub_p;               /* DH; partner's public value */
 137         vchar_t *dhgxy;                 /* DH; shared secret */
 138         vchar_t *nonce;                 /* nonce value */
 139         vchar_t *nonce_p;               /* partner's nonce value */
 140         vchar_t *skeyid;                /* SKEYID */
 141         vchar_t *skeyid_d;              /* SKEYID_d */
 142         vchar_t *skeyid_a;              /* SKEYID_a, i.e. hash */
 143         vchar_t *skeyid_e;              /* SKEYID_e, i.e. encryption */
 144         vchar_t *key;                   /* cipher key */
 145         vchar_t *hash;                  /* HASH minus general header */
 146         vchar_t *sig;                   /* SIG minus general header */
 147         vchar_t *sig_p;                 /* peer's SIG minus general header */
 148         cert_t *cert;                   /* CERT minus general header */
 149         cert_t *cert_p;                 /* peer's CERT minus general header */
 150         cert_t *crl_p;                  /* peer's CRL minus general header */
 151         cert_t *cr_p;                   /* peer's CR not including general */
 152         vchar_t *id;                    /* ID minus gen header */
 153         vchar_t *id_p;                  /* partner's ID minus general header */
 154                                         /* i.e. strut ipsecdoi_id_b*. */
 155         struct isakmp_ivm *ivm;         /* IVs */
 156
 157         vchar_t *sa;                    /* whole SA payload to send/to be sent*/
 158                                         /* to calculate HASH */
 159                                         /* NOT INCLUDING general header. */
 160
 161         vchar_t *sa_ret;                /* SA payload to reply/to be replyed */
 162                                         /* NOT INCLUDING general header. */
 163                                         /* NOTE: Should be release after use. */
 164
 165 #ifdef HAVE_GSSAPI
 166         void *gssapi_state;             /* GSS-API specific state. */
 167                                         /* Allocated when needed */
 168         vchar_t *gi_i;                  /* optional initiator GSS id */
 169         vchar_t *gi_r;                  /* optional responder GSS id */
 170 #endif
 171
 172         struct isakmp_pl_hash *pl_hash; /* pointer to hash payload */
 173
 174         time_t created;                 /* timestamp for establish */
 175 #ifdef ENABLE_STATS
 176         struct timeval start;
 177         struct timeval end;
 178 #endif
 179
 180 #ifdef IKE_NAT_T
 181         natt_flags_t    natt_flags;
 182         vchar_t                 *local_natd;
 183         vchar_t                 *remote_natd;
 184 #endif
 185
 186         u_int32_t msgid2;               /* msgid counter for Phase 2 */
 187         int ph2cnt;     /* the number which is negotiated by this phase 1 */
 188         LIST_HEAD(_ph2ofph1_, ph2handle) ph2tree;
 189
 190         LIST_ENTRY(ph1handle) chain;
 191 };
 192
 193 /* Phase 2 handler */
 194 /* allocated per a SA or SA bundles of a pair of peer's IP addresses. */
 195 /*
 196  *      initiator               responder
 197  *  0   (---)                   (---)
 198  *  1   start                   start (1st msg received)
 199  *  2   acquire msg get         1st valid msg received
 200  *  3   getspi request sent     getspi request sent
 201  *  4   getspi done             getspi done
 202  *  5   1st msg sent            1st msg sent
 203  *  6   1st valid msg received  2nd valid msg received
 204  *  7   (commit bit)            (commit bit)
 205  *  8   SAs added               SAs added
 206  *  9   SAs established         SAs established
 207  * 10   SAs expired             SAs expired
 208  */
 209 #define PHASE2ST_SPAWN          0
 210 #define PHASE2ST_START          1
 211 #define PHASE2ST_STATUS2        2
 212 #define PHASE2ST_GETSPISENT     3
 213 #define PHASE2ST_GETSPIDONE     4
 214 #define PHASE2ST_MSG1SENT       5
 215 #define PHASE2ST_STATUS6        6
 216 #define PHASE2ST_COMMIT         7
 217 #define PHASE2ST_ADDSA          8
 218 #define PHASE2ST_ESTABLISHED    9
 219 #define PHASE2ST_EXPIRED        10
 220 #define PHASE2ST_MAX            11
 221
 222 struct ph2handle {
 223         struct sockaddr *src;           /* my address of SA. */
 224         struct sockaddr *dst;           /* peer's address of SA. */
 225
 226                 /*
 227                  * copy ip address from ID payloads when ID type is ip address.
 228                  * In other case, they must be null.
 229                  */
 230         struct sockaddr *src_id;
 231         struct sockaddr *dst_id;
 232
 233         u_int32_t spid;                 /* policy id by kernel */
 234
 235         int status;                     /* ipsec sa status */
 236         u_int8_t side;                  /* INITIATOR or RESPONDER */
 237
 238         struct sched *sce;              /* schedule for expire */
 239         struct sched *scr;              /* schedule for resend */
 240         int retry_counter;              /* for resend. */
 241         vchar_t *sendbuf;               /* buffer for re-sending */
 242         vchar_t *msg1;                  /* buffer for re-sending */
 243                                 /* used for responder's first message */
 244
 245         int retry_checkph1;             /* counter to wait phase 1 finished. */
 246                                         /* NOTE: actually it's timer. */
 247
 248         u_int32_t seq;                  /* sequence number used by PF_KEY */
 249                         /*
 250                          * NOTE: In responder side, we can't identify each SAs
 251                          * with same destination address for example, when
 252                          * socket based SA is required.  So we set a identifier
 253                          * number to "seq", and sent kernel by pfkey.
 254                          */
 255         u_int8_t satype;                /* satype in PF_KEY */
 256                         /*
 257                          * saved satype in the original PF_KEY request from
 258                          * the kernel in order to reply a error.
 259                          */
 260
 261         u_int8_t flags;                 /* Flags for phase 2 */
 262         u_int32_t msgid;                /* msgid for phase 2 */
 263
 264         struct sainfo *sainfo;          /* place holder of sainfo */
 265         struct saprop *proposal;        /* SA(s) proposal. */
 266         struct saprop *approval;        /* SA(s) approved. */
 267         caddr_t spidx_gen;              /* policy from peer's proposal */
 268
 269         struct dhgroup *pfsgrp;         /* DH; prime number */
 270         vchar_t *dhpriv;                /* DH; private value */
 271         vchar_t *dhpub;                 /* DH; public value */
 272         vchar_t *dhpub_p;               /* DH; partner's public value */
 273         vchar_t *dhgxy;                 /* DH; shared secret */
 274         vchar_t *id;                    /* ID minus gen header */
 275         vchar_t *id_p;                  /* peer's ID minus general header */
 276         vchar_t *nonce;                 /* nonce value in phase 2 */
 277         vchar_t *nonce_p;               /* partner's nonce value in phase 2 */
 278
 279         vchar_t *sa;                    /* whole SA payload to send/to be sent*/
 280                                         /* to calculate HASH */
 281                                         /* NOT INCLUDING general header. */
 282
 283         vchar_t *sa_ret;                /* SA payload to reply/to be replyed */
 284                                         /* NOT INCLUDING general header. */
 285                                         /* NOTE: Should be release after use. */
 286
 287         struct isakmp_ivm *ivm;         /* IVs */
 288
 289 #ifdef ENABLE_STATS
 290         struct timeval start;
 291         struct timeval end;
 292 #endif
 293         struct ph1handle *ph1;  /* back pointer to isakmp status */
 294
 295         LIST_ENTRY(ph2handle) chain;
 296         LIST_ENTRY(ph2handle) ph1bind;  /* chain to ph1handle */
 297 };
 298
 299 /*
 300  * for handling initial contact.
 301  */
 302 struct contacted {
 303         struct sockaddr *remote;        /* remote address to negosiate ph1 */
 304         LIST_ENTRY(contacted) chain;
 305 };
 306
 307 /*
 308  * for checking a packet retransmited.
 309  */
 310 struct recvdpkt {
 311         struct sockaddr *remote;        /* the remote address */
 312         struct sockaddr *local;         /* the local address */
 313         vchar_t *hash;                  /* hash of the received packet */
 314         vchar_t *sendbuf;               /* buffer for the response */
 315         int retry_counter;              /* how many times to send */
 316         time_t time_send;               /* timestamp to send a packet */
 317         time_t created;                 /* timestamp to create a queue */
 318
 319         struct sched *scr;              /* schedule for resend, may not used */
 320
 321         LIST_ENTRY(recvdpkt) chain;
 322 };
 323
 324 /* for parsing ISAKMP header. */
 325 struct isakmp_parse_t {
 326         u_char type;            /* payload type of mine */
 327         int len;                /* ntohs(ptr->len) */
 328         struct isakmp_gen *ptr;
 329 };
 330
 331 /*
 332  * for IV management.
 333  *
 334  * - normal case
 335  * initiator                                     responder
 336  * -------------------------                     --------------------------
 337  * initialize iv(A), ive(A).                     initialize iv(A), ive(A).
 338  * encode by ive(A).
 339  * save to iv(B).            ---[packet(B)]-->   save to ive(B).
 340  *                                               decode by iv(A).
 341  *                                               packet consistency.
 342  *                                               sync iv(B) with ive(B).
 343  *                                               check auth, integrity.
 344  *                                               encode by ive(B).
 345  * save to ive(C).          <--[packet(C)]---    save to iv(C).
 346  * decoded by iv(B).
 347  *      :
 348  *
 349  * - In the case that a error is found while cipher processing,
 350  * initiator                                     responder
 351  * -------------------------                     --------------------------
 352  * initialize iv(A), ive(A).                     initialize iv(A), ive(A).
 353  * encode by ive(A).
 354  * save to iv(B).            ---[packet(B)]-->   save to ive(B).
 355  *                                               decode by iv(A).
 356  *                                               packet consistency.
 357  *                                               sync iv(B) with ive(B).
 358  *                                               check auth, integrity.
 359  *                                               error found.
 360  *                                               create notify.
 361  *                                               get ive2(X) from iv(B).
 362  *                                               encode by ive2(X).
 363  * get iv2(X) from iv(B).   <--[packet(Y)]---    save to iv2(Y).
 364  * save to ive2(Y).
 365  * decoded by iv2(X).
 366  *      :
 367  *
 368  * The reason why the responder synchronizes iv with ive after checking the
 369  * packet consistency is that it is required to leave the IV for decoding
 370  * packet.  Because there is a potential of error while checking the packet
 371  * consistency.  Also the reason why that is before authentication and
 372  * integirty check is that the IV for informational exchange has to be made
 373  * by the IV which is after packet decoded and checking the packet consistency.
 374  * Otherwise IV mismatched happens between the intitiator and the responder.
 375  */
 376 struct isakmp_ivm {
 377         vchar_t *iv;    /* for decoding packet */
 378                         /* if phase 1, it's for computing phase2 iv */
 379         vchar_t *ive;   /* for encoding packet */
 380 };
 381
 382 /* for dumping */
 383 struct ph1dump {
 384         isakmp_index index;
 385         int status;
 386         int side;
 387         struct sockaddr_storage remote;
 388         struct sockaddr_storage local;
 389         u_int8_t version;
 390         u_int8_t etype;
 391         time_t created;
 392         int ph2cnt;
 393 };
 394
 395 struct sockaddr;
 396 struct ph1handle;
 397 struct ph2handle;
 398 struct policyindex;
 399
 400 extern struct ph1handle *getph1byindex __P((isakmp_index *));
 401 extern struct ph1handle *getph1byindex0 __P((isakmp_index *));
 402 extern struct ph1handle *getph1byaddr __P((struct sockaddr *,
 403         struct sockaddr *));
 404 extern vchar_t *dumpph1 __P((void));
 405 extern struct ph1handle *newph1 __P((void));
 406 extern void delph1 __P((struct ph1handle *));
 407 extern int insph1 __P((struct ph1handle *));
 408 extern void remph1 __P((struct ph1handle *));
 409 extern void flushph1 __P((void));
 410 extern void initph1tree __P((void));
 411
 412 extern struct ph2handle *getph2byspidx __P((struct policyindex *));
 413 extern struct ph2handle *getph2byspid __P((u_int32_t));
 414 extern struct ph2handle *getph2byseq __P((u_int32_t));
 415 extern struct ph2handle *getph2bymsgid __P((struct ph1handle *, u_int32_t));
 416 extern struct ph2handle *getph2bysaidx __P((struct sockaddr *,
 417         struct sockaddr *, u_int, u_int32_t));
 418 extern struct ph2handle *newph2 __P((void));
 419 extern void initph2 __P((struct ph2handle *));
 420 extern void delph2 __P((struct ph2handle *));
 421 extern int insph2 __P((struct ph2handle *));
 422 extern void remph2 __P((struct ph2handle *));
 423 extern void flushph2 __P((void));
 424 extern void deleteallph2 __P((struct sockaddr *, struct sockaddr *, u_int));
 425 extern void initph2tree __P((void));
 426
 427 extern void bindph12 __P((struct ph1handle *, struct ph2handle *));
 428 extern void unbindph12 __P((struct ph2handle *));
 429
 430 extern struct contacted *getcontacted __P((struct sockaddr *));
 431 extern int inscontacted __P((struct sockaddr *));
 432 extern void initctdtree __P((void));
 433
 434 extern int check_recvdpkt __P((struct sockaddr *,
 435         struct sockaddr *, vchar_t *));
 436 extern int add_recvdpkt __P((struct sockaddr *, struct sockaddr *,
 437         vchar_t *, vchar_t *));
 438 extern void init_recvdpkt __P((void));
 439
 440 #endif /* __HANDLER_H__ */
 441