sctp_auth.h revision 166675
1/*- 2 * Copyright (c) 2001-2007, Cisco Systems, Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * a) Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 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. 13 * 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. 17 * 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. 29 */ 30 31#include <sys/cdefs.h> 32__FBSDID("$FreeBSD: head/sys/netinet/sctp_auth.h 166675 2007-02-12 23:24:31Z rrs $"); 33 34#ifndef __SCTP_AUTH_H__ 35#define __SCTP_AUTH_H__ 36 37 38/* digest lengths */ 39#define SCTP_AUTH_DIGEST_LEN_SHA1 20 40#define SCTP_AUTH_DIGEST_LEN_MD5 16 41#define SCTP_AUTH_DIGEST_LEN_SHA224 28 42#define SCTP_AUTH_DIGEST_LEN_SHA256 32 43#define SCTP_AUTH_DIGEST_LEN_SHA384 48 44#define SCTP_AUTH_DIGEST_LEN_SHA512 64 45#define SCTP_AUTH_DIGEST_LEN_MAX 64 46 47/* random sizes */ 48#define SCTP_AUTH_RANDOM_SIZE_DEFAULT 32 49#define SCTP_AUTH_RANDOM_SIZE_REQUIRED 32 50#define SCTP_AUTH_RANDOM_SIZE_MAX 256 51 52/* union of all supported HMAC algorithm contexts */ 53typedef union sctp_hash_context { 54 SHA1_CTX sha1; 55 MD5_CTX md5; 56#ifdef HAVE_SHA2 57 SHA256_CTX sha256; 58 SHA384_CTX sha384; 59 SHA512_CTX sha512; 60#endif 61} sctp_hash_context_t; 62 63typedef struct sctp_key { 64 uint32_t keylen; 65 uint8_t key[0]; 66} sctp_key_t; 67 68typedef struct sctp_shared_key { 69 LIST_ENTRY(sctp_shared_key) next; 70 sctp_key_t *key; /* key text */ 71 uint16_t keyid; /* shared key ID */ 72} sctp_sharedkey_t; 73 74LIST_HEAD(sctp_keyhead, sctp_shared_key); 75 76/* authentication chunks list */ 77typedef struct sctp_auth_chklist { 78 uint8_t chunks[256]; 79 uint8_t num_chunks; 80} sctp_auth_chklist_t; 81 82/* hmac algos supported list */ 83typedef struct sctp_hmaclist { 84 uint16_t max_algo; /* max algorithms allocated */ 85 uint16_t num_algo; /* num algorithms used */ 86 uint16_t hmac[0]; 87} sctp_hmaclist_t; 88 89/* authentication info */ 90typedef 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 uint16_t assoc_keyid; /* current send keyid (cached) */ 95 uint16_t recv_keyid; /* last recv keyid (cached) */ 96 sctp_key_t *assoc_key; /* cached send key */ 97 sctp_key_t *recv_key; /* cached recv key */ 98} sctp_authinfo_t; 99 100 101/* 102 * global variables 103 */ 104extern uint32_t sctp_asconf_auth_nochk; /* sysctl to disable ASCONF auth chk */ 105extern uint32_t sctp_auth_disable; /* sysctl for temp feature interop */ 106extern uint32_t sctp_auth_random_len; /* sysctl */ 107 108/* 109 * Macros 110 */ 111 112#define sctp_auth_is_required_chunk(chunk, list) ((list == NULL) ? (0) : (list->chunks[chunk] != 0)) 113 114/* 115 * function prototypes 116 */ 117 118/* socket option api functions */ 119extern sctp_auth_chklist_t *sctp_alloc_chunklist(void); 120extern void sctp_free_chunklist(sctp_auth_chklist_t * chklist); 121extern void sctp_clear_chunklist(sctp_auth_chklist_t * chklist); 122extern sctp_auth_chklist_t *sctp_copy_chunklist(sctp_auth_chklist_t * chklist); 123extern int sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t * list); 124extern int sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t * list); 125extern size_t sctp_auth_get_chklist_size(const sctp_auth_chklist_t * list); 126extern void sctp_auth_set_default_chunks(sctp_auth_chklist_t * list); 127extern int 128 sctp_serialize_auth_chunks(const sctp_auth_chklist_t * list, uint8_t * ptr); 129extern int sctp_pack_auth_chunks(const sctp_auth_chklist_t * list, uint8_t * ptr); 130extern int 131sctp_unpack_auth_chunks(const uint8_t * ptr, uint8_t num_chunks, 132 sctp_auth_chklist_t * list); 133 134/* key handling */ 135extern sctp_key_t *sctp_alloc_key(uint32_t keylen); 136extern void sctp_free_key(sctp_key_t * key); 137extern void sctp_print_key(sctp_key_t * key, const char *str); 138extern void sctp_show_key(sctp_key_t * key, const char *str); 139extern sctp_key_t *sctp_generate_random_key(uint32_t keylen); 140extern sctp_key_t *sctp_set_key(uint8_t * key, uint32_t keylen); 141extern sctp_key_t * 142sctp_compute_hashkey(sctp_key_t * key1, sctp_key_t * key2, 143 sctp_key_t * shared); 144 145/* shared key handling */ 146extern sctp_sharedkey_t *sctp_alloc_sharedkey(void); 147extern void sctp_free_sharedkey(sctp_sharedkey_t * skey); 148extern sctp_sharedkey_t * 149 sctp_find_sharedkey(struct sctp_keyhead *shared_keys, uint16_t key_id); 150extern void 151sctp_insert_sharedkey(struct sctp_keyhead *shared_keys, 152 sctp_sharedkey_t * new_skey); 153extern int 154sctp_copy_skeylist(const struct sctp_keyhead *src, 155 struct sctp_keyhead *dest); 156 157/* hmac list handling */ 158extern sctp_hmaclist_t *sctp_alloc_hmaclist(uint8_t num_hmacs); 159extern void sctp_free_hmaclist(sctp_hmaclist_t * list); 160extern int sctp_auth_add_hmacid(sctp_hmaclist_t * list, uint16_t hmac_id); 161extern sctp_hmaclist_t *sctp_copy_hmaclist(sctp_hmaclist_t * list); 162extern sctp_hmaclist_t *sctp_default_supported_hmaclist(void); 163extern uint16_t 164sctp_negotiate_hmacid(sctp_hmaclist_t * peer, 165 sctp_hmaclist_t * local); 166extern int sctp_serialize_hmaclist(sctp_hmaclist_t * list, uint8_t * ptr); 167extern int 168sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs, 169 uint32_t num_hmacs); 170 171extern sctp_authinfo_t *sctp_alloc_authinfo(void); 172extern void sctp_free_authinfo(sctp_authinfo_t * authinfo); 173 174/* keyed-HMAC functions */ 175extern uint32_t sctp_get_auth_chunk_len(uint16_t hmac_algo); 176extern uint32_t sctp_get_hmac_digest_len(uint16_t hmac_algo); 177extern uint32_t 178sctp_hmac(uint16_t hmac_algo, uint8_t * key, uint32_t keylen, 179 uint8_t * text, uint32_t textlen, uint8_t * digest); 180extern int 181sctp_verify_hmac(uint16_t hmac_algo, uint8_t * key, uint32_t keylen, 182 uint8_t * text, uint32_t textlen, uint8_t * digest, 183 uint32_t digestlen); 184extern uint32_t 185sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t * key, 186 uint8_t * text, uint32_t textlen, uint8_t * digest); 187extern int sctp_auth_is_supported_hmac(sctp_hmaclist_t * list, uint16_t id); 188 189/* mbuf versions */ 190extern uint32_t 191sctp_hmac_m(uint16_t hmac_algo, uint8_t * key, uint32_t keylen, 192 struct mbuf *m, uint32_t m_offset, uint8_t * digest); 193extern uint32_t 194sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t * key, struct mbuf *m, 195 uint32_t m_offset, uint8_t * digest); 196 197/* 198 * authentication routines 199 */ 200extern void sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid); 201extern void sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid); 202extern int sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid); 203extern int sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid); 204extern int sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid); 205extern int sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid); 206 207extern void 208sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m, 209 uint32_t offset, uint32_t length); 210extern void 211sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset, 212 struct sctp_auth_chunk *auth, 213 struct sctp_tcb *stcb); 214extern struct mbuf * 215sctp_add_auth_chunk(struct mbuf *m, struct mbuf **m_end, 216 struct sctp_auth_chunk **auth_ret, 217 uint32_t * offset, struct sctp_tcb *stcb, 218 uint8_t chunk); 219extern int 220sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *ch, 221 struct mbuf *m, uint32_t offset); 222extern void 223sctp_notify_authentication(struct sctp_tcb *stcb, 224 uint32_t indication, uint16_t keyid, 225 uint16_t alt_keyid); 226extern int 227 sctp_validate_init_auth_params(struct mbuf *m, int offset, int limit); 228extern void 229 sctp_initialize_auth_params(struct sctp_inpcb *inp, struct sctp_tcb *stcb); 230 231 232/* test functions */ 233extern void sctp_test_hmac_sha1(void); 234extern void sctp_test_hmac_md5(void); 235extern void sctp_test_authkey(void); 236 237#endif /* __SCTP_AUTH_H__ */ 238