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