X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=src%2Fvnet%2Fipsec%2Fipsec.api;h=89dcdb761de6c5df5980e3574a383df7c83776cf;hp=ece0b024485f2af537bbc8deb0ac7594fa397c76;hb=00f21fb2f;hpb=8d7c502002636da1cb7c71a87757f328e7c2c4fd diff --git a/src/vnet/ipsec/ipsec.api b/src/vnet/ipsec/ipsec.api index ece0b024485..89dcdb761de 100644 --- a/src/vnet/ipsec/ipsec.api +++ b/src/vnet/ipsec/ipsec.api @@ -14,9 +14,13 @@ * limitations under the License. */ -option version = "3.0.0"; +option version = "4.0.0"; +import "vnet/ipsec/ipsec_types.api"; +import "vnet/interface_types.api"; import "vnet/ip/ip_types.api"; +import "vnet/interface_types.api"; +import "vnet/tunnel/tunnel_types.api"; /** \brief IPsec: Add/delete Security Policy Database @param client_index - opaque cookie to identify the sender @@ -29,7 +33,7 @@ autoreply define ipsec_spd_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add; u32 spd_id; }; @@ -48,8 +52,8 @@ autoreply define ipsec_interface_add_del_spd u32 client_index; u32 context; - u8 is_add; - u32 sw_if_index; + bool is_add; + vl_api_interface_index_t sw_if_index; u32 spd_id; }; @@ -89,10 +93,11 @@ typedef ipsec_spd_entry { u32 spd_id; i32 priority; - u8 is_outbound; + bool is_outbound; u32 sa_id; vl_api_ipsec_spd_action_t policy; + /* Which protocol?? */ u8 protocol; // Selector @@ -118,7 +123,7 @@ define ipsec_spd_entry_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add; vl_api_ipsec_spd_entry_t entry; }; @@ -153,7 +158,7 @@ define ipsec_spds_details { u32 context; u32 spd_id; u32 npolicies; -}; +}; /** \brief Dump ipsec policy database data @param client_index - opaque cookie to identify the sender @@ -179,394 +184,106 @@ define ipsec_spd_details { vl_api_ipsec_spd_entry_t entry; }; -/* - * @brief Support cryptographic algorithms - */ -enum ipsec_crypto_alg -{ - IPSEC_API_CRYPTO_ALG_NONE = 0, - IPSEC_API_CRYPTO_ALG_AES_CBC_128, - IPSEC_API_CRYPTO_ALG_AES_CBC_192, - IPSEC_API_CRYPTO_ALG_AES_CBC_256, - IPSEC_API_CRYPTO_ALG_AES_CTR_128, - IPSEC_API_CRYPTO_ALG_AES_CTR_192, - IPSEC_API_CRYPTO_ALG_AES_CTR_256, - IPSEC_API_CRYPTO_ALG_AES_GCM_128, - IPSEC_API_CRYPTO_ALG_AES_GCM_192, - IPSEC_API_CRYPTO_ALG_AES_GCM_256, - IPSEC_API_CRYPTO_ALG_DES_CBC, - IPSEC_API_CRYPTO_ALG_3DES_CBC, -}; - -/* - * @brief Supported Integrity Algorithms - */ -enum ipsec_integ_alg -{ - IPSEC_API_INTEG_ALG_NONE = 0, - /* RFC2403 */ - IPSEC_API_INTEG_ALG_MD5_96, - /* RFC2404 */ - IPSEC_API_INTEG_ALG_SHA1_96, - /* draft-ietf-ipsec-ciph-sha-256-00 */ - IPSEC_API_INTEG_ALG_SHA_256_96, - /* RFC4868 */ - IPSEC_API_INTEG_ALG_SHA_256_128, - /* RFC4868 */ - IPSEC_API_INTEG_ALG_SHA_384_192, - /* RFC4868 */ - IPSEC_API_INTEG_ALG_SHA_512_256, -}; - -enum ipsec_sad_flags -{ - IPSEC_API_SAD_FLAG_NONE = 0, - /* Enable extended sequence numbers */ - IPSEC_API_SAD_FLAG_USE_EXTENDED_SEQ_NUM = 0x01, - /* Enable Anti-replay */ - IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02, - /* IPsec tunnel mode if non-zero, else transport mode */ - IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04, - /* IPsec tunnel mode is IPv6 if non-zero, - * else IPv4 tunnel only valid if is_tunnel is non-zero */ - IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08, - /* enable UDP encapsulation for NAT traversal */ - IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10, - - /* come-on Ole please fix this */ - IPSEC_API_SAD_COMBO_12 = 12, - IPSEC_API_SAD_COMBO_20 = 20, -}; - -enum ipsec_proto -{ - IPSEC_API_PROTO_ESP, - IPSEC_API_PROTO_AH, -}; - -typedef key -{ - /* the length of the key */ - u8 length; - /* The data for the key */ - u8 data[128]; -}; - -/** \brief IPsec: Security Association Database entry - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param is_add - add SAD entry if non-zero, else delete - @param sad_id - sad id - @param spi - security parameter index - @param protocol - 0 = AH, 1 = ESP - @param crypto_algorithm - a supported crypto algorithm - @param crypto_key - crypto keying material - @param integrity_algorithm - one of the supported algorithms - @param integrity_key - integrity keying material - @param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero - @param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero - @param tx_table_id - the FIB id used for encapsulated packets - */ -typedef ipsec_sad_entry -{ - u32 sad_id; - - u32 spi; - - vl_api_ipsec_proto_t protocol; - - vl_api_ipsec_crypto_alg_t crypto_algorithm; - vl_api_key_t crypto_key; - - vl_api_ipsec_integ_alg_t integrity_algorithm; - vl_api_key_t integrity_key; - - vl_api_ipsec_sad_flags_t flags; - - vl_api_address_t tunnel_src; - vl_api_address_t tunnel_dst; - u32 tx_table_id; -}; - /** \brief IPsec: Add/delete Security Association Database entry @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param entry - Entry to add or delete */ -autoreply define ipsec_sad_entry_add_del +define ipsec_sad_entry_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add; vl_api_ipsec_sad_entry_t entry; }; - -/** \brief IPsec: Update Security Association keys - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param sa_id - sa id - - @param crypto_key - crypto keying material - @param integrity_key - integrity keying material -*/ - -autoreply define ipsec_sa_set_key +define ipsec_sad_entry_add_del_reply { - u32 client_index; u32 context; - - u32 sa_id; - - vl_api_key_t crypto_key; - vl_api_key_t integrity_key; -}; - -/** \brief IKEv2: Add/delete profile - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_add - Add IKEv2 profile if non-zero, else delete -*/ -autoreply define ikev2_profile_add_del -{ - u32 client_index; - u32 context; - - u8 name[64]; - u8 is_add; -}; - -/** \brief IKEv2: Set IKEv2 profile authentication method - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig) - @param is_hex - Authentication data in hex format if non-zero, else string - @param data_len - Authentication data length - @param data - Authentication data (for rsa-sig cert file path) -*/ -autoreply define ikev2_profile_set_auth -{ - u32 client_index; - u32 context; - - u8 name[64]; - u8 auth_method; - u8 is_hex; - u32 data_len; - u8 data[data_len]; -}; - -/** \brief IKEv2: Set IKEv2 profile local/remote identification - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_local - Identification is local if non-zero, else remote - @param id_type - Identification type - @param data_len - Identification data length - @param data - Identification data -*/ -autoreply define ikev2_profile_set_id -{ - u32 client_index; - u32 context; - - u8 name[64]; - u8 is_local; - u8 id_type; - u32 data_len; - u8 data[data_len]; -}; - -/** \brief IKEv2: Set IKEv2 profile traffic selector parameters - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_local - Traffic selector is local if non-zero, else remote - @param proto - Traffic selector IP protocol (if zero not relevant) - @param start_port - The smallest port number allowed by traffic selector - @param end_port - The largest port number allowed by traffic selector - @param start_addr - The smallest address included in traffic selector - @param end_addr - The largest address included in traffic selector -*/ -autoreply define ikev2_profile_set_ts -{ - u32 client_index; - u32 context; - - u8 name[64]; - u8 is_local; - u8 proto; - u16 start_port; - u16 end_port; - u32 start_addr; - u32 end_addr; -}; - -/** \brief IKEv2: Set IKEv2 local RSA private key - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param key_file - Key file absolute path -*/ -autoreply define ikev2_set_local_key -{ - u32 client_index; - u32 context; - - u8 key_file[256]; -}; - -/** \brief IKEv2: Set IKEv2 responder interface and IP address - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param sw_if_index - interface index - @param address - interface address -*/ -autoreply define ikev2_set_responder -{ - u32 client_index; - u32 context; - - u8 name[64]; - u32 sw_if_index; - u8 address[4]; + i32 retval; + u32 stat_index; }; -/** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param crypto_alg - encryption algorithm - @param crypto_key_size - encryption key size - @param integ_alg - integrity algorithm - @param dh_group - Diffie-Hellman group - -*/ -autoreply define ikev2_set_ike_transforms -{ - u32 client_index; - u32 context; - - u8 name[64]; - u32 crypto_alg; - u32 crypto_key_size; - u32 integ_alg; - u32 dh_group; -}; +/** \brief Add or Update Protection for a tunnel with IPSEC + + Tunnel protection directly associates an SA with all packets + ingress and egress on the tunnel. This could also be achieved by + assigning an SPD to the tunnel, but that would incur an unnessccary + SPD entry lookup. + + For tunnels the ESP acts on the post-encapsulated packet. So if this + packet: + +---------+------+ + | Payload | O-IP | + +---------+------+ + where O-IP is the overlay IP addrees that was routed into the tunnel, + the resulting encapsulated packet will be: + +---------+------+------+ + | Payload | O-IP | T-IP | + +---------+------+------+ + where T-IP is the tunnel's src.dst IP addresses. + If the SAs used for protection are in transport mode then the ESP is + inserted before T-IP, i.e.: + +---------+------+-----+------+ + | Payload | O-IP | ESP | T-IP | + +---------+------+-----+------+ + If the SAs used for protection are in tunnel mode then another + encapsulation occurs, i.e.: + +---------+------+------+-----+------+ + | Payload | O-IP | T-IP | ESP | C-IP | + +---------+------+------+-----+------+ + where C-IP are the crypto endpoint IP addresses defined as the tunnel + endpoints in the SA. + The mode for the inbound and outbound SA must be the same. -/** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param crypto_alg - encryption algorithm - @param crypto_key_size - encryption key size - @param integ_alg - integrity algorithm - @param dh_group - Diffie-Hellman group - -*/ -autoreply define ikev2_set_esp_transforms + @param sw_id_index - Tunnel interface to protect + @param nh - The peer/next-hop on the tunnel to which the traffic + should be protected. For a P2P interface set this to the + all 0s address. + @param sa_in - The ID [set] of inbound SAs + @param sa_out - The ID of outbound SA +*/ +typedef ipsec_tunnel_protect { - u32 client_index; - u32 context; - - u8 name[64]; - u32 crypto_alg; - u32 crypto_key_size; - u32 integ_alg; - u32 dh_group; + vl_api_interface_index_t sw_if_index; + vl_api_address_t nh; + u32 sa_out; + u8 n_sa_in; + u32 sa_in[n_sa_in]; }; -/** \brief IKEv2: Set Child SA lifetime, limited by time and/or data - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param lifetime - SA maximum life time in seconds (0 to disable) - @param lifetime_jitter - Jitter added to prevent simultaneous rekeying - @param handover - Hand over time - @param lifetime_maxdata - SA maximum life time in bytes (0 to disable) - -*/ -autoreply define ikev2_set_sa_lifetime +autoreply define ipsec_tunnel_protect_update { u32 client_index; u32 context; - u8 name[64]; - u64 lifetime; - u32 lifetime_jitter; - u32 handover; - u64 lifetime_maxdata; + vl_api_ipsec_tunnel_protect_t tunnel; }; -/** \brief IKEv2: Initiate the SA_INIT exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - -*/ -autoreply define ikev2_initiate_sa_init +autoreply define ipsec_tunnel_protect_del { u32 client_index; u32 context; - u8 name[64]; + vl_api_interface_index_t sw_if_index; + vl_api_address_t nh; }; -/** \brief IKEv2: Initiate the delete IKE SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - IKE SA initiator SPI - -*/ -autoreply define ikev2_initiate_del_ike_sa -{ - u32 client_index; - u32 context; - - u64 ispi; -}; - -/** \brief IKEv2: Initiate the delete Child SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - Child SA initiator SPI - -*/ -autoreply define ikev2_initiate_del_child_sa +/** + * @brief Dump all tunnel protections + */ +define ipsec_tunnel_protect_dump { u32 client_index; u32 context; - - u32 ispi; + vl_api_interface_index_t sw_if_index; }; -/** \brief IKEv2: Initiate the rekey Child SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - Child SA initiator SPI - -*/ -autoreply define ikev2_initiate_rekey_child_sa +define ipsec_tunnel_protect_details { - u32 client_index; u32 context; - - u32 ispi; + vl_api_ipsec_tunnel_protect_t tun; }; /** \brief IPsec: Get SPD interfaces @@ -591,13 +308,18 @@ define ipsec_spd_interface_dump { define ipsec_spd_interface_details { u32 context; u32 spd_index; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; }; /** \brief Add or delete IPsec tunnel interface + + !!DEPRECATED!! + use the tunnel protect APIs instead + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add IPsec tunnel interface if nonzero, else delete + @param is_ip6 - tunnel v6 or v4 @param esn - enable extended sequence numbers if nonzero, else disable @param anti_replay - enable anti replay check if nonzero, else disable @param local_ip - local IP address @@ -618,15 +340,17 @@ define ipsec_spd_interface_details { @param show_instance - instance to display for intf if renumber is set @param udp_encap - enable UDP encapsulation for NAT traversal @param tx_table_id - the FIB id used after packet encap + @param salt - for use with counter mode ciphers */ define ipsec_tunnel_if_add_del { + option deprecated; u32 client_index; u32 context; - u8 is_add; - u8 esn; - u8 anti_replay; - u8 local_ip[4]; - u8 remote_ip[4]; + bool is_add; + bool esn; + bool anti_replay; + vl_api_address_t local_ip; + vl_api_address_t remote_ip; u32 local_spi; u32 remote_spi; u8 crypto_alg; @@ -639,10 +363,11 @@ define ipsec_tunnel_if_add_del { u8 local_integ_key[128]; u8 remote_integ_key_len; u8 remote_integ_key[128]; - u8 renumber; + bool renumber; u32 show_instance; - u8 udp_encap; + bool udp_encap; u32 tx_table_id; + u32 salt; }; /** \brief Add/delete IPsec tunnel interface response @@ -653,7 +378,54 @@ define ipsec_tunnel_if_add_del { define ipsec_tunnel_if_add_del_reply { u32 context; i32 retval; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; +}; + +typedef ipsec_itf +{ + u32 user_instance [default=0xffffffff]; + vl_api_tunnel_mode_t mode; + vl_api_interface_index_t sw_if_index; +}; + +/** \brief Create an IPSec interface + */ +define ipsec_itf_create { + u32 client_index; + u32 context; + vl_api_ipsec_itf_t itf; +}; + +/** \brief Add IPsec interface interface response + @param context - sender context, to match reply w/ request + @param retval - return status + @param sw_if_index - sw_if_index of new interface (for successful add) +*/ +define ipsec_itf_create_reply +{ + u32 context; + i32 retval; + vl_api_interface_index_t sw_if_index; +}; + +autoreply define ipsec_itf_delete +{ + u32 client_index; + u32 context; + vl_api_interface_index_t sw_if_index; +}; + +define ipsec_itf_dump +{ + u32 client_index; + u32 context; + vl_api_interface_index_t sw_if_index; +}; + +define ipsec_itf_details +{ + u32 context; + vl_api_ipsec_itf_t itf; }; /** \brief Dump IPsec security association @@ -661,7 +433,8 @@ define ipsec_tunnel_if_add_del_reply { @param context - sender context, to match reply w/ request @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD */ -define ipsec_sa_dump { +define ipsec_sa_dump +{ u32 client_index; u32 context; u32 sa_id; @@ -669,7 +442,7 @@ define ipsec_sa_dump { /** \brief IPsec security association database response @param context - sender context which was passed in the request - @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0 + @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0 @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0 @param spi - security parameter index @param protocol - IPsec protocol (value from ipsec_protocol_t) @@ -685,48 +458,32 @@ define ipsec_sa_dump { @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6 @param tunnel_src_addr - Tunnel source address if using tunnel mode @param tunnel_dst_addr - Tunnel destination address is using tunnel mode - @param salt - 4 byte salt + @param salt - 4 byte salt @param seq - current sequence number for outbound - @param seq_hi - high 32 bits of ESN for outbound + @param seq_hi - high 32 bits of ESN for outbound @param last_seq - highest sequence number received inbound @param last_seq_hi - high 32 bits of highest ESN received inbound @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay - @param total_data_size - total bytes sent or received + @param stat_index - index for the SA in the stats segment @ /net/ipsec/sa @param udp_encap - 1 if UDP encap enabled, 0 otherwise */ define ipsec_sa_details { u32 context; vl_api_ipsec_sad_entry_t entry; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u32 salt; u64 seq_outbound; u64 last_seq_inbound; u64 replay_window; - u64 total_data_size; -}; - -/** \brief Set key on IPsec interface - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param sw_if_index - index of tunnel interface - @param key_type - type of key being set - @param alg - algorithm used with key - @param key_len - length key in bytes - @param key - key -*/ -autoreply define ipsec_tunnel_if_set_key { - u32 client_index; - u32 context; - u32 sw_if_index; - u8 key_type; - u8 alg; - u8 key_len; - u8 key[128]; + u32 stat_index; }; /** \brief Set new SA on IPsec interface + + !! DEPRECATED !! + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of tunnel interface @@ -734,9 +491,10 @@ autoreply define ipsec_tunnel_if_set_key { @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote) */ autoreply define ipsec_tunnel_if_set_sa { + option deprecated; u32 client_index; u32 context; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u32 sa_id; u8 is_outbound; }; @@ -758,10 +516,10 @@ define ipsec_backend_dump { */ define ipsec_backend_details { u32 context; - u8 name[128]; + string name[128]; vl_api_ipsec_proto_t protocol; u8 index; - u8 active; + bool active; }; /** \brief Select IPsec backend @@ -777,9 +535,20 @@ autoreply define ipsec_select_backend { u8 index; }; + +/** \brief IPsec Set Async mode + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param async_enable - ipsec async mode on or off +*/ +autoreply define ipsec_set_async_mode { + u32 client_index; + u32 context; + bool async_enable; +}; + /* * Local Variables: * eval: (c-set-style "gnu") * End: */ -