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