Return to ike_mobike.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libcharon / sa / ikev2 / tasks

Annotation of embedaddon/strongswan/src/libcharon/sa/ikev2/tasks/ike_mobike.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2007 Martin Willi
        !             3:  * HSR 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 ike_mobike ike_mobike
        !            18:  * @{ @ingroup tasks_v2
        !            19:  */
        !            20: 
        !            21: #ifndef IKE_MOBIKE_H_
        !            22: #define IKE_MOBIKE_H_
        !            23: 
        !            24: typedef struct ike_mobike_t ike_mobike_t;
        !            25: 
        !            26: #include <library.h>
        !            27: #include <sa/ike_sa.h>
        !            28: #include <sa/task.h>
        !            29: #include <networking/packet.h>
        !            30: 
        !            31: /**
        !            32:  * Task of type ike_mobike, detects and handles MOBIKE extension.
        !            33:  *
        !            34:  * The MOBIKE extension is defined in RFC4555. It allows to update IKE
        !            35:  * and IPsec tunnel addresses.
        !            36:  * This tasks handles the MOBIKE_SUPPORTED notify exchange to detect MOBIKE
        !            37:  * support, allows the exchange of ADDITIONAL_*_ADDRESS to exchange additional
        !            38:  * endpoints and handles the UPDATE_SA_ADDRESS notify to finally update
        !            39:  * endpoints.
        !            40:  */
        !            41: struct ike_mobike_t {
        !            42: 
        !            43:        /**
        !            44:         * Implements the task_t interface
        !            45:         */
        !            46:        task_t task;
        !            47: 
        !            48:        /**
        !            49:         * Use the task to update the list of additional addresses.
        !            50:         */
        !            51:        void (*addresses)(ike_mobike_t *this);
        !            52: 
        !            53:        /**
        !            54:         * Use the task to roam to other addresses.
        !            55:         *
        !            56:         * @param address               TRUE to include address list update
        !            57:         */
        !            58:        void (*roam)(ike_mobike_t *this, bool address);
        !            59: 
        !            60:        /**
        !            61:         * Use the task for a DPD check which detects changes in NAT mappings.
        !            62:         */
        !            63:        void (*dpd)(ike_mobike_t *this);
        !            64: 
        !            65:        /**
        !            66:         * Transmission hook, called by task manager.
        !            67:         *
        !            68:         * The task manager calls this hook whenever it transmits a packet. It
        !            69:         * allows the mobike task to send the packet on multiple paths to do path
        !            70:         * probing.
        !            71:         *
        !            72:         * @param packet                the packet to transmit
        !            73:         * @return                              TRUE if transmitted, FALSE if no path found
        !            74:         */
        !            75:        bool (*transmit)(ike_mobike_t *this, packet_t *packet);
        !            76: 
        !            77:        /**
        !            78:         * Check if this task is probing for routability.
        !            79:         *
        !            80:         * @return                              TRUE if task is probing
        !            81:         */
        !            82:        bool (*is_probing)(ike_mobike_t *this);
        !            83: 
        !            84:        /**
        !            85:         * Enable probing for routability.
        !            86:         */
        !            87:        void (*enable_probing)(ike_mobike_t *this);
        !            88: };
        !            89: 
        !            90: /**
        !            91:  * Create a new ike_mobike task.
        !            92:  *
        !            93:  * @param ike_sa               IKE_SA this task works for
        !            94:  * @param initiator            TRUE if task is initiated by us
        !            95:  * @return                             ike_mobike task to handle by the task_manager
        !            96:  */
        !            97: ike_mobike_t *ike_mobike_create(ike_sa_t *ike_sa, bool initiator);
        !            98: 
        !            99: #endif /** IKE_MOBIKE_H_ @}*/