2 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * a) Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
10 * b) Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the distribution.
14 * c) Neither the name of Cisco Systems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGE.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #ifndef __SCTP_AUTH_H__
35 #define __SCTP_AUTH_H__
39 #define SCTP_AUTH_DIGEST_LEN_SHA1 20
40 #define SCTP_AUTH_DIGEST_LEN_SHA224 28
41 #define SCTP_AUTH_DIGEST_LEN_SHA256 32
42 #define SCTP_AUTH_DIGEST_LEN_SHA384 48
43 #define SCTP_AUTH_DIGEST_LEN_SHA512 64
44 #define SCTP_AUTH_DIGEST_LEN_MAX 64
47 #define SCTP_AUTH_RANDOM_SIZE_DEFAULT 32
48 #define SCTP_AUTH_RANDOM_SIZE_REQUIRED 32
49 #define SCTP_AUTH_RANDOM_SIZE_MAX 256
51 /* union of all supported HMAC algorithm contexts */
52 typedef union sctp_hash_context {
59 } sctp_hash_context_t;
61 typedef struct sctp_key {
66 typedef struct sctp_shared_key {
67 LIST_ENTRY(sctp_shared_key) next;
68 sctp_key_t *key; /* key text */
69 uint32_t refcount; /* reference count */
70 uint16_t keyid; /* shared key ID */
71 uint8_t deactivated; /* key is deactivated */
74 LIST_HEAD(sctp_keyhead, sctp_shared_key);
76 /* authentication chunks list */
77 typedef struct sctp_auth_chklist {
80 } sctp_auth_chklist_t;
82 /* hmac algos supported list */
83 typedef struct sctp_hmaclist {
84 uint16_t max_algo; /* max algorithms allocated */
85 uint16_t num_algo; /* num algorithms used */
89 /* authentication info */
90 typedef struct sctp_authinfo {
91 sctp_key_t *random; /* local random key (concatenated) */
92 uint32_t random_len; /* local random number length for param */
93 sctp_key_t *peer_random;/* peer's random key (concatenated) */
94 sctp_key_t *assoc_key; /* cached concatenated send key */
95 sctp_key_t *recv_key; /* cached concatenated recv key */
96 uint16_t active_keyid; /* active send keyid */
97 uint16_t assoc_keyid; /* current send keyid (cached) */
98 uint16_t recv_keyid; /* last recv keyid (cached) */
106 #define sctp_auth_is_required_chunk(chunk, list) ((list == NULL) ? (0) : (list->chunks[chunk] != 0))
109 * function prototypes
112 /* socket option api functions */
113 extern sctp_auth_chklist_t *sctp_alloc_chunklist(void);
114 extern void sctp_free_chunklist(sctp_auth_chklist_t * chklist);
115 extern void sctp_clear_chunklist(sctp_auth_chklist_t * chklist);
116 extern sctp_auth_chklist_t *sctp_copy_chunklist(sctp_auth_chklist_t * chklist);
117 extern int sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t * list);
118 extern int sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t * list);
119 extern size_t sctp_auth_get_chklist_size(const sctp_auth_chklist_t * list);
120 extern void sctp_auth_set_default_chunks(sctp_auth_chklist_t * list);
122 sctp_serialize_auth_chunks(const sctp_auth_chklist_t * list,
125 sctp_pack_auth_chunks(const sctp_auth_chklist_t * list,
128 sctp_unpack_auth_chunks(const uint8_t * ptr, uint8_t num_chunks,
129 sctp_auth_chklist_t * list);
132 extern sctp_key_t *sctp_alloc_key(uint32_t keylen);
133 extern void sctp_free_key(sctp_key_t * key);
134 extern void sctp_print_key(sctp_key_t * key, const char *str);
135 extern void sctp_show_key(sctp_key_t * key, const char *str);
136 extern sctp_key_t *sctp_generate_random_key(uint32_t keylen);
137 extern sctp_key_t *sctp_set_key(uint8_t * key, uint32_t keylen);
139 sctp_compute_hashkey(sctp_key_t * key1, sctp_key_t * key2,
140 sctp_key_t * shared);
142 /* shared key handling */
143 extern sctp_sharedkey_t *sctp_alloc_sharedkey(void);
144 extern void sctp_free_sharedkey(sctp_sharedkey_t * skey);
145 extern sctp_sharedkey_t *
146 sctp_find_sharedkey(struct sctp_keyhead *shared_keys,
149 sctp_insert_sharedkey(struct sctp_keyhead *shared_keys,
150 sctp_sharedkey_t * new_skey);
152 sctp_copy_skeylist(const struct sctp_keyhead *src,
153 struct sctp_keyhead *dest);
155 /* ref counts on shared keys, by key id */
156 extern void sctp_auth_key_acquire(struct sctp_tcb *stcb, uint16_t keyid);
157 extern void sctp_auth_key_release(struct sctp_tcb *stcb, uint16_t keyid);
160 /* hmac list handling */
161 extern sctp_hmaclist_t *sctp_alloc_hmaclist(uint8_t num_hmacs);
162 extern void sctp_free_hmaclist(sctp_hmaclist_t * list);
163 extern int sctp_auth_add_hmacid(sctp_hmaclist_t * list, uint16_t hmac_id);
164 extern sctp_hmaclist_t *sctp_copy_hmaclist(sctp_hmaclist_t * list);
165 extern sctp_hmaclist_t *sctp_default_supported_hmaclist(void);
167 sctp_negotiate_hmacid(sctp_hmaclist_t * peer,
168 sctp_hmaclist_t * local);
169 extern int sctp_serialize_hmaclist(sctp_hmaclist_t * list, uint8_t * ptr);
171 sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs,
174 extern sctp_authinfo_t *sctp_alloc_authinfo(void);
175 extern void sctp_free_authinfo(sctp_authinfo_t * authinfo);
177 /* keyed-HMAC functions */
178 extern uint32_t sctp_get_auth_chunk_len(uint16_t hmac_algo);
179 extern uint32_t sctp_get_hmac_digest_len(uint16_t hmac_algo);
181 sctp_hmac(uint16_t hmac_algo, uint8_t * key, uint32_t keylen,
182 uint8_t * text, uint32_t textlen, uint8_t * digest);
184 sctp_verify_hmac(uint16_t hmac_algo, uint8_t * key, uint32_t keylen,
185 uint8_t * text, uint32_t textlen, uint8_t * digest, uint32_t digestlen);
187 sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t * key,
188 uint8_t * text, uint32_t textlen, uint8_t * digest);
189 extern int sctp_auth_is_supported_hmac(sctp_hmaclist_t * list, uint16_t id);
193 sctp_hmac_m(uint16_t hmac_algo, uint8_t * key, uint32_t keylen,
194 struct mbuf *m, uint32_t m_offset, uint8_t * digest, uint32_t trailer);
196 sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t * key,
197 struct mbuf *m, uint32_t m_offset, uint8_t * digest);
200 * authentication routines
202 extern void sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid);
203 extern void sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid);
204 extern int sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid);
205 extern int sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid);
206 extern int sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid);
207 extern int sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid);
208 extern int sctp_deact_sharedkey(struct sctp_tcb *stcb, uint16_t keyid);
209 extern int sctp_deact_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid);
212 sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m,
213 uint32_t offset, uint32_t length);
215 sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset,
216 struct sctp_auth_chunk *auth, struct sctp_tcb *stcb, uint16_t key_id);
218 sctp_add_auth_chunk(struct mbuf *m, struct mbuf **m_end,
219 struct sctp_auth_chunk **auth_ret, uint32_t * offset,
220 struct sctp_tcb *stcb, uint8_t chunk);
222 sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *ch,
223 struct mbuf *m, uint32_t offset);
225 sctp_notify_authentication(struct sctp_tcb *stcb,
226 uint32_t indication, uint16_t keyid, uint16_t alt_keyid, int so_locked);
228 sctp_validate_init_auth_params(struct mbuf *m, int offset,
231 sctp_initialize_auth_params(struct sctp_inpcb *inp,
232 struct sctp_tcb *stcb);
235 #endif /* __SCTP_AUTH_H__ */