X-Git-Url: https://git.strongswan.org/?p=strongswan.git;a=blobdiff_plain;f=Source%2Fcharon%2Fsa%2Fchild_sa.h;h=3e8a6fea4198493812c07bdf5ece11da3f7987f3;hp=da8883cc95fb019d148534b98bdca61338db32ed;hb=144f676cf5375b3066a19e6b2dc3a3d01b054c78;hpb=f7cf9f61c43662aa1de1cab6080c45d78302b7f6 diff --git a/Source/charon/sa/child_sa.h b/Source/charon/sa/child_sa.h index da8883c..3e8a6fe 100644 --- a/Source/charon/sa/child_sa.h +++ b/Source/charon/sa/child_sa.h @@ -31,24 +31,41 @@ typedef struct child_sa_t child_sa_t; /** - * @brief + * @brief Represents a CHILD_SA between to hosts. + * + * An IKE_SA must already be established. + * + * @b Constructors: + * - child_sa_create + * * @ingroup sa */ struct child_sa_t { + /** + * @brief Returns the SPI value of this CHILD_SA. + * + * AH and ESP are using 4 byte SPI values. + * + * @param this calling object + * @return 4 Byte SPI value + */ u_int32_t (*get_spi) (child_sa_t *this); /** * @brief Destroys a child_sa. * - * @param this child_sa_t object + * @param this calling object */ void (*destroy) (child_sa_t *this); }; /** - * @brief + * @brief Constructor to create a new CHILD_SA. * + * @param protocol_id protocol id (AH or ESP) of CHILD_SA + * @param prf_plus prf_plus_t object use to derive shared secrets + * @return child_sa_t object * @ingroup sa */ child_sa_t * child_sa_create(protocol_id_t protocol_id, prf_plus_t *prf_plus);