1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved. 5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. 6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions are met: 10 * 11 * a) Redistributions of source code must retain the above copyright notice, 12 * this list of conditions and the following disclaimer. 13 * 14 * b) Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the distribution. 17 * 18 * c) Neither the name of Cisco Systems, Inc. nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 32 * THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #if defined(__FreeBSD__) && !defined(__Userspace__) 36 #include <sys/cdefs.h> 37 __FBSDID("$FreeBSD: head/sys/netinet/sctp_auth.h 338749 2018-09-18 10:53:07Z tuexen $"); 38 #endif 39 40 #ifndef _NETINET_SCTP_AUTH_H_ 41 #define _NETINET_SCTP_AUTH_H_ 42 43 #include <netinet/sctp_os.h> 44 45 /* digest lengths */ 46 #define SCTP_AUTH_DIGEST_LEN_SHA1 20 47 #define SCTP_AUTH_DIGEST_LEN_SHA256 32 48 #define SCTP_AUTH_DIGEST_LEN_MAX SCTP_AUTH_DIGEST_LEN_SHA256 49 50 /* random sizes */ 51 #define SCTP_AUTH_RANDOM_SIZE_DEFAULT 32 52 #define SCTP_AUTH_RANDOM_SIZE_REQUIRED 32 53 54 /* union of all supported HMAC algorithm contexts */ 55 typedef union sctp_hash_context { 56 SCTP_SHA1_CTX sha1; 57 #if defined(SCTP_SUPPORT_HMAC_SHA256) 58 SCTP_SHA256_CTX sha256; 59 #endif 60 } sctp_hash_context_t; 61 62 typedef struct sctp_key { 63 uint32_t keylen; 64 uint8_t key[]; 65 } sctp_key_t; 66 67 typedef struct sctp_shared_key { 68 LIST_ENTRY(sctp_shared_key) next; 69 sctp_key_t *key; /* key text */ 70 uint32_t refcount; /* reference count */ 71 uint16_t keyid; /* shared key ID */ 72 uint8_t deactivated; /* key is deactivated */ 73 } sctp_sharedkey_t; 74 75 LIST_HEAD(sctp_keyhead, sctp_shared_key); 76 77 /* authentication chunks list */ 78 typedef struct sctp_auth_chklist { 79 uint8_t chunks[256]; 80 uint8_t num_chunks; 81 } sctp_auth_chklist_t; 82 83 /* hmac algos supported list */ 84 typedef struct sctp_hmaclist { 85 uint16_t max_algo; /* max algorithms allocated */ 86 uint16_t num_algo; /* num algorithms used */ 87 uint16_t hmac[]; 88 } sctp_hmaclist_t; 89 90 /* authentication info */ 91 typedef struct sctp_authinformation { 92 sctp_key_t *random; /* local random key (concatenated) */ 93 uint32_t random_len; /* local random number length for param */ 94 sctp_key_t *peer_random;/* peer's random key (concatenated) */ 95 sctp_key_t *assoc_key; /* cached concatenated send key */ 96 sctp_key_t *recv_key; /* cached concatenated recv key */ 97 uint16_t active_keyid; /* active send keyid */ 98 uint16_t assoc_keyid; /* current send keyid (cached) */ 99 uint16_t recv_keyid; /* last recv keyid (cached) */ 100 } sctp_authinfo_t; 101 102 103 104 /* 105 * Macros 106 */ 107 #define sctp_auth_is_required_chunk(chunk, list) ((list == NULL) ? (0) : (list->chunks[chunk] != 0)) 108 109 /* 110 * function prototypes 111 */ 112 113 /* socket option api functions */ 114 extern sctp_auth_chklist_t *sctp_alloc_chunklist(void); 115 extern void sctp_free_chunklist(sctp_auth_chklist_t *chklist); 116 extern void sctp_clear_chunklist(sctp_auth_chklist_t *chklist); 117 extern sctp_auth_chklist_t *sctp_copy_chunklist(sctp_auth_chklist_t *chklist); 118 extern int sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t *list); 119 extern int sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t *list); 120 extern size_t sctp_auth_get_chklist_size(const sctp_auth_chklist_t *list); 121 extern int sctp_serialize_auth_chunks(const sctp_auth_chklist_t *list, 122 uint8_t *ptr); 123 extern int sctp_pack_auth_chunks(const sctp_auth_chklist_t *list, 124 uint8_t *ptr); 125 extern int sctp_unpack_auth_chunks(const uint8_t *ptr, uint8_t num_chunks, 126 sctp_auth_chklist_t *list); 127 128 /* key handling */ 129 extern sctp_key_t *sctp_alloc_key(uint32_t keylen); 130 extern void sctp_free_key(sctp_key_t *key); 131 extern void sctp_print_key(sctp_key_t *key, const char *str); 132 extern void sctp_show_key(sctp_key_t *key, const char *str); 133 extern sctp_key_t *sctp_generate_random_key(uint32_t keylen); 134 extern sctp_key_t *sctp_set_key(uint8_t *key, uint32_t keylen); 135 extern sctp_key_t *sctp_compute_hashkey(sctp_key_t *key1, sctp_key_t *key2, 136 sctp_key_t *shared); 137 138 /* shared key handling */ 139 extern sctp_sharedkey_t *sctp_alloc_sharedkey(void); 140 extern void sctp_free_sharedkey(sctp_sharedkey_t *skey); 141 extern sctp_sharedkey_t *sctp_find_sharedkey(struct sctp_keyhead *shared_keys, 142 uint16_t key_id); 143 extern int sctp_insert_sharedkey(struct sctp_keyhead *shared_keys, 144 sctp_sharedkey_t *new_skey); 145 extern int sctp_copy_skeylist(const struct sctp_keyhead *src, 146 struct sctp_keyhead *dest); 147 /* ref counts on shared keys, by key id */ 148 extern void sctp_auth_key_acquire(struct sctp_tcb *stcb, uint16_t keyid); 149 extern void sctp_auth_key_release(struct sctp_tcb *stcb, uint16_t keyid, 150 int so_locked); 151 152 153 /* hmac list handling */ 154 extern sctp_hmaclist_t *sctp_alloc_hmaclist(uint16_t num_hmacs); 155 extern void sctp_free_hmaclist(sctp_hmaclist_t *list); 156 extern int sctp_auth_add_hmacid(sctp_hmaclist_t *list, uint16_t hmac_id); 157 extern sctp_hmaclist_t *sctp_copy_hmaclist(sctp_hmaclist_t *list); 158 extern sctp_hmaclist_t *sctp_default_supported_hmaclist(void); 159 extern uint16_t sctp_negotiate_hmacid(sctp_hmaclist_t *peer, 160 sctp_hmaclist_t *local); 161 extern int sctp_serialize_hmaclist(sctp_hmaclist_t *list, uint8_t *ptr); 162 extern int sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs, 163 uint32_t num_hmacs); 164 165 extern sctp_authinfo_t *sctp_alloc_authinfo(void); 166 extern void sctp_free_authinfo(sctp_authinfo_t *authinfo); 167 168 /* keyed-HMAC functions */ 169 extern uint32_t sctp_get_auth_chunk_len(uint16_t hmac_algo); 170 extern uint32_t sctp_get_hmac_digest_len(uint16_t hmac_algo); 171 extern uint32_t sctp_hmac(uint16_t hmac_algo, uint8_t *key, uint32_t keylen, 172 uint8_t *text, uint32_t textlen, uint8_t *digest); 173 extern uint32_t sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t *key, 174 uint8_t *text, uint32_t textlen, uint8_t *digest); 175 extern int sctp_auth_is_supported_hmac(sctp_hmaclist_t *list, uint16_t id); 176 177 /* mbuf versions */ 178 extern uint32_t sctp_hmac_m(uint16_t hmac_algo, uint8_t *key, uint32_t keylen, 179 struct mbuf *m, uint32_t m_offset, uint8_t *digest, uint32_t trailer); 180 extern uint32_t sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t *key, 181 struct mbuf *m, uint32_t m_offset, uint8_t *digest); 182 183 /* 184 * authentication routines 185 */ 186 extern void sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid); 187 extern void sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid); 188 extern int sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid); 189 extern int sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid); 190 extern int sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid); 191 extern int sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid); 192 extern int sctp_deact_sharedkey(struct sctp_tcb *stcb, uint16_t keyid); 193 extern int sctp_deact_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid); 194 195 extern void sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m, 196 uint32_t offset, uint32_t length); 197 extern void sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset, 198 struct sctp_auth_chunk *auth, struct sctp_tcb *stcb, uint16_t key_id); 199 extern struct mbuf *sctp_add_auth_chunk(struct mbuf *m, struct mbuf **m_end, 200 struct sctp_auth_chunk **auth_ret, uint32_t *offset, 201 struct sctp_tcb *stcb, uint8_t chunk); 202 extern int sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *ch, 203 struct mbuf *m, uint32_t offset); 204 extern void sctp_notify_authentication(struct sctp_tcb *stcb, 205 uint32_t indication, uint16_t keyid, uint16_t alt_keyid, int so_locked); 206 extern int sctp_validate_init_auth_params(struct mbuf *m, int offset, 207 int limit); 208 extern void sctp_initialize_auth_params(struct sctp_inpcb *inp, 209 struct sctp_tcb *stcb); 210 211 /* test functions */ 212 #ifdef SCTP_HMAC_TEST 213 extern void sctp_test_hmac_sha1(void); 214 extern void sctp_test_authkey(void); 215 #endif 216 #endif /* __SCTP_AUTH_H__ */ 217