src/libcharon/sa/ikev2/tasks/child_create.h

   1 /*
   2  * Copyright (C) 2007 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup child_create child_create
  18  * @{ @ingroup tasks_v2
  19  */
  20
  21 #ifndef CHILD_CREATE_H_
  22 #define CHILD_CREATE_H_
  23
  24 typedef struct child_create_t child_create_t;
  25
  26 #include <library.h>
  27 #include <sa/ike_sa.h>
  28 #include <sa/task.h>
  29 #include <config/child_cfg.h>
  30
  31 /**
  32  * Task of type TASK_CHILD_CREATE, established a new CHILD_SA.
  33  *
  34  * This task may be included in the IKE_AUTH message or in a separate
  35  * CREATE_CHILD_SA exchange.
  36  */
  37 struct child_create_t {
  38
  39         /**
  40          * Implements the task_t interface
  41          */
  42         task_t task;
  43
  44         /**
  45          * Use a specific reqid for the CHILD_SA.
  46          *
  47          * When this task is used for rekeying, the same reqid is used
  48          * for the new CHILD_SA.
  49          *
  50          * @param reqid         reqid to use
  51          */
  52         void (*use_reqid) (child_create_t *this, u_int32_t reqid);
  53
  54         /**
  55          * Get the lower of the two nonces, used for rekey collisions.
  56          *
  57          * @return                      lower nonce
  58          */
  59         chunk_t (*get_lower_nonce) (child_create_t *this);
  60
  61         /**
  62          * Get the CHILD_SA established/establishing by this task.
  63          *
  64          * @return                      child_sa
  65          */
  66         child_sa_t* (*get_child) (child_create_t *this);
  67 };
  68
  69 /**
  70  * Create a new child_create task.
  71  *
  72  * @param ike_sa                IKE_SA this task works for
  73  * @param config                child_cfg if task initiator, NULL if responder
  74  * @param rekey                 whether we do a rekey or not
  75  * @param tsi                   source of triggering packet, or NULL
  76  * @param tsr                   destination of triggering packet, or NULL
  77  * @return                              child_create task to handle by the task_manager
  78  */
  79 child_create_t *child_create_create(ike_sa_t *ike_sa,
  80                                                         child_cfg_t *config, bool rekey,
  81                                                         traffic_selector_t *tsi, traffic_selector_t *tsr);
  82
  83 #endif /** CHILD_CREATE_H_ @}*/