ipsec: USE_EXTENDED_SEQ_NUM -> USE_ESN
[vpp.git] / src / vnet / ipsec / esp.h
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __ESP_H__
16 #define __ESP_H__
17
18 #include <vnet/ip/ip.h>
19 #include <vnet/crypto/crypto.h>
20 #include <vnet/ipsec/ipsec.h>
21
22 typedef struct
23 {
24   u32 spi;
25   u32 seq;
26   u8 data[0];
27 } esp_header_t;
28
29 typedef struct
30 {
31   u8 pad_length;
32   u8 next_header;
33 } esp_footer_t;
34
35 /* *INDENT-OFF* */
36 typedef CLIB_PACKED (struct {
37   ip4_header_t ip4;
38   esp_header_t esp;
39 }) ip4_and_esp_header_t;
40 /* *INDENT-ON* */
41
42 /* *INDENT-OFF* */
43 typedef CLIB_PACKED (struct {
44   ip4_header_t ip4;
45   udp_header_t udp;
46   esp_header_t esp;
47 }) ip4_and_udp_and_esp_header_t;
48 /* *INDENT-ON* */
49
50 /* *INDENT-OFF* */
51 typedef CLIB_PACKED (struct {
52   ip6_header_t ip6;
53   esp_header_t esp;
54 }) ip6_and_esp_header_t;
55 /* *INDENT-ON* */
56
57 #define ESP_SEQ_MAX             (4294967295UL)
58 #define ESP_MAX_BLOCK_SIZE      (16)
59 #define ESP_MAX_ICV_SIZE        (16)
60
61 u8 *format_esp_header (u8 * s, va_list * args);
62
63 /* TODO seq increment should be atomic to be accessed by multiple workers */
64 always_inline int
65 esp_seq_advance (ipsec_sa_t * sa)
66 {
67   if (PREDICT_TRUE (ipsec_sa_is_set_USE_ESN (sa)))
68     {
69       if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
70         {
71           if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
72                              sa->seq_hi == ESP_SEQ_MAX))
73             return 1;
74           sa->seq_hi++;
75         }
76       sa->seq++;
77     }
78   else
79     {
80       if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
81                          sa->seq == ESP_SEQ_MAX))
82         return 1;
83       sa->seq++;
84     }
85
86   return 0;
87 }
88
89
90 always_inline unsigned int
91 hmac_calc (vlib_main_t * vm, ipsec_sa_t * sa, u8 * data, int data_len,
92            u8 * signature)
93 {
94   vnet_crypto_op_t _op, *op = &_op;
95
96   if (PREDICT_FALSE (sa->integ_op_type == 0))
97     return 0;
98
99   op->op = sa->integ_op_type;
100   op->key = sa->integ_key.data;
101   op->key_len = sa->integ_key.len;
102   op->src = data;
103   op->len = data_len;
104   op->dst = signature;
105   op->hmac_trunc_len = sa->integ_trunc_size;
106
107   if (ipsec_sa_is_set_USE_ESN (sa))
108     {
109       u32 seq_hi = clib_host_to_net_u32 (sa->seq_hi);
110
111       op->len += 4;
112       clib_memcpy (data + data_len, &seq_hi, 4);
113     }
114
115   vnet_crypto_process_ops (vm, op, 1);
116   return sa->integ_trunc_size;
117 }
118
119 #endif /* __ESP_H__ */
120
121 /*
122  * fd.io coding-style-patch-verification: ON
123  *
124  * Local Variables:
125  * eval: (c-set-style "gnu")
126  * End:
127  */