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 #include <sys/cdefs.h> 36 #ifndef _NETINET_SCTP_AUTH_H_ 37 #define _NETINET_SCTP_AUTH_H_ 38 39 #include <netinet/sctp_os.h> 40 41 /* digest lengths */ 42 #define SCTP_AUTH_DIGEST_LEN_SHA1 20 43 #define SCTP_AUTH_DIGEST_LEN_SHA256 32 44 #define SCTP_AUTH_DIGEST_LEN_MAX SCTP_AUTH_DIGEST_LEN_SHA256 45 46 /* random sizes */ 47 #define SCTP_AUTH_RANDOM_SIZE_DEFAULT 32 48 #define SCTP_AUTH_RANDOM_SIZE_REQUIRED 32 49 50 /* union of all supported HMAC algorithm contexts */ 51 typedef union sctp_hash_context { 52 SCTP_SHA1_CTX sha1; 53 SCTP_SHA256_CTX sha256; 54 } sctp_hash_context_t; 55 56 typedef struct sctp_key { 57 uint32_t keylen; 58 uint8_t key[]; 59 } sctp_key_t; 60 61 typedef struct sctp_shared_key { 62 LIST_ENTRY(sctp_shared_key) next; 63 sctp_key_t *key; /* key text */ 64 uint32_t refcount; /* reference count */ 65 uint16_t keyid; /* shared key ID */ 66 uint8_t deactivated; /* key is deactivated */ 67 } sctp_sharedkey_t; 68 69 LIST_HEAD(sctp_keyhead, sctp_shared_key); 70 71 /* authentication chunks list */ 72 typedef struct sctp_auth_chklist { 73 uint8_t chunks[256]; 74 uint8_t num_chunks; 75 } sctp_auth_chklist_t; 76 77 /* hmac algos supported list */ 78 typedef struct sctp_hmaclist { 79 uint16_t max_algo; /* max algorithms allocated */ 80 uint16_t num_algo; /* num algorithms used */ 81 uint16_t hmac[]; 82 } sctp_hmaclist_t; 83 84 /* authentication info */ 85 typedef struct sctp_authinformation { 86 sctp_key_t *random; /* local random key (concatenated) */ 87 uint32_t random_len; /* local random number length for param */ 88 sctp_key_t *peer_random; /* peer's random key (concatenated) */ 89 sctp_key_t *assoc_key; /* cached concatenated send key */ 90 sctp_key_t *recv_key; /* cached concatenated recv key */ 91 uint16_t active_keyid; /* active send keyid */ 92 uint16_t assoc_keyid; /* current send keyid (cached) */ 93 uint16_t recv_keyid; /* last recv keyid (cached) */ 94 } sctp_authinfo_t; 95 96 /* 97 * Macros 98 */ 99 #define sctp_auth_is_required_chunk(chunk, list) ((list == NULL) ? (0) : (list->chunks[chunk] != 0)) 100 101 /* 102 * function prototypes 103 */ 104 105 /* socket option api functions */ 106 extern sctp_auth_chklist_t *sctp_alloc_chunklist(void); 107 extern void sctp_free_chunklist(sctp_auth_chklist_t *chklist); 108 extern void sctp_clear_chunklist(sctp_auth_chklist_t *chklist); 109 extern sctp_auth_chklist_t *sctp_copy_chunklist(sctp_auth_chklist_t *chklist); 110 extern int sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t *list); 111 extern int sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t *list); 112 extern size_t sctp_auth_get_chklist_size(const sctp_auth_chklist_t *list); 113 extern int 114 sctp_serialize_auth_chunks(const sctp_auth_chklist_t *list, 115 uint8_t *ptr); 116 extern int 117 sctp_pack_auth_chunks(const sctp_auth_chklist_t *list, 118 uint8_t *ptr); 119 extern int 120 sctp_unpack_auth_chunks(const uint8_t *ptr, uint8_t num_chunks, 121 sctp_auth_chklist_t *list); 122 123 /* key handling */ 124 extern sctp_key_t *sctp_alloc_key(uint32_t keylen); 125 extern void sctp_free_key(sctp_key_t *key); 126 extern void sctp_print_key(sctp_key_t *key, const char *str); 127 extern void sctp_show_key(sctp_key_t *key, const char *str); 128 extern sctp_key_t *sctp_generate_random_key(uint32_t keylen); 129 extern sctp_key_t *sctp_set_key(uint8_t *key, uint32_t keylen); 130 extern sctp_key_t * 131 sctp_compute_hashkey(sctp_key_t *key1, sctp_key_t *key2, 132 sctp_key_t *shared); 133 134 /* shared key handling */ 135 extern sctp_sharedkey_t *sctp_alloc_sharedkey(void); 136 extern void sctp_free_sharedkey(sctp_sharedkey_t *skey); 137 extern sctp_sharedkey_t * 138 sctp_find_sharedkey(struct sctp_keyhead *shared_keys, 139 uint16_t key_id); 140 extern int 141 sctp_insert_sharedkey(struct sctp_keyhead *shared_keys, 142 sctp_sharedkey_t *new_skey); 143 extern int 144 sctp_copy_skeylist(const struct sctp_keyhead *src, 145 struct sctp_keyhead *dest); 146 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 150 sctp_auth_key_release(struct sctp_tcb *stcb, uint16_t keyid, 151 int so_locked); 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 160 sctp_negotiate_hmacid(sctp_hmaclist_t *peer, 161 sctp_hmaclist_t *local); 162 extern int sctp_serialize_hmaclist(sctp_hmaclist_t *list, uint8_t *ptr); 163 extern int 164 sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs, 165 uint32_t num_hmacs); 166 167 extern sctp_authinfo_t *sctp_alloc_authinfo(void); 168 extern void sctp_free_authinfo(sctp_authinfo_t *authinfo); 169 170 /* keyed-HMAC functions */ 171 extern uint32_t sctp_get_auth_chunk_len(uint16_t hmac_algo); 172 extern uint32_t sctp_get_hmac_digest_len(uint16_t hmac_algo); 173 extern uint32_t 174 sctp_hmac(uint16_t hmac_algo, uint8_t *key, uint32_t keylen, 175 uint8_t *text, uint32_t textlen, uint8_t *digest); 176 extern uint32_t 177 sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t *key, 178 uint8_t *text, uint32_t textlen, uint8_t *digest); 179 extern int sctp_auth_is_supported_hmac(sctp_hmaclist_t *list, uint16_t id); 180 181 /* mbuf versions */ 182 extern uint32_t 183 sctp_hmac_m(uint16_t hmac_algo, uint8_t *key, uint32_t keylen, 184 struct mbuf *m, uint32_t m_offset, uint8_t *digest, uint32_t trailer); 185 extern uint32_t 186 sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t *key, 187 struct mbuf *m, uint32_t m_offset, uint8_t *digest); 188 189 /* 190 * authentication routines 191 */ 192 extern void sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid); 193 extern void sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid); 194 extern int sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid); 195 extern int sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid); 196 extern int sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid); 197 extern int sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid); 198 extern int sctp_deact_sharedkey(struct sctp_tcb *stcb, uint16_t keyid); 199 extern int sctp_deact_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid); 200 201 extern void 202 sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m, 203 uint32_t offset, uint32_t length); 204 extern void 205 sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset, 206 struct sctp_auth_chunk *auth, struct sctp_tcb *stcb, uint16_t key_id); 207 extern struct mbuf * 208 sctp_add_auth_chunk(struct mbuf *m, struct mbuf **m_end, 209 struct sctp_auth_chunk **auth_ret, uint32_t *offset, 210 struct sctp_tcb *stcb, uint8_t chunk); 211 extern int 212 sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *ch, 213 struct mbuf *m, uint32_t offset); 214 extern void 215 sctp_notify_authentication(struct sctp_tcb *stcb, 216 uint32_t indication, uint16_t keyid, uint16_t alt_keyid, int so_locked); 217 extern int 218 sctp_validate_init_auth_params(struct mbuf *m, int offset, 219 int limit); 220 extern void 221 sctp_initialize_auth_params(struct sctp_inpcb *inp, 222 struct sctp_tcb *stcb); 223 224 /* test functions */ 225 #endif /* __SCTP_AUTH_H__ */ 226