2 * SPDX-License-Identifier: BSD-3-Clause
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.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
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.
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.
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.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <netinet/sctp_os.h>
39 #include <netinet/sctp.h>
40 #include <netinet/sctp_header.h>
41 #include <netinet/sctp_pcb.h>
42 #include <netinet/sctp_var.h>
43 #include <netinet/sctp_sysctl.h>
44 #include <netinet/sctputil.h>
45 #include <netinet/sctp_indata.h>
46 #include <netinet/sctp_output.h>
47 #include <netinet/sctp_auth.h>
50 #define SCTP_AUTH_DEBUG (SCTP_BASE_SYSCTL(sctp_debug_on) & SCTP_DEBUG_AUTH1)
51 #define SCTP_AUTH_DEBUG2 (SCTP_BASE_SYSCTL(sctp_debug_on) & SCTP_DEBUG_AUTH2)
52 #endif /* SCTP_DEBUG */
56 sctp_clear_chunklist(sctp_auth_chklist_t *chklist)
58 memset(chklist, 0, sizeof(*chklist));
59 /* chklist->num_chunks = 0; */
63 sctp_alloc_chunklist(void)
65 sctp_auth_chklist_t *chklist;
67 SCTP_MALLOC(chklist, sctp_auth_chklist_t *, sizeof(*chklist),
69 if (chklist == NULL) {
70 SCTPDBG(SCTP_DEBUG_AUTH1, "sctp_alloc_chunklist: failed to get memory!\n");
72 sctp_clear_chunklist(chklist);
78 sctp_free_chunklist(sctp_auth_chklist_t *list)
81 SCTP_FREE(list, SCTP_M_AUTH_CL);
85 sctp_copy_chunklist(sctp_auth_chklist_t *list)
87 sctp_auth_chklist_t *new_list;
93 new_list = sctp_alloc_chunklist();
97 memcpy(new_list, list, sizeof(*new_list));
104 * add a chunk to the required chunks list
107 sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t *list)
112 /* is chunk restricted? */
113 if ((chunk == SCTP_INITIATION) ||
114 (chunk == SCTP_INITIATION_ACK) ||
115 (chunk == SCTP_SHUTDOWN_COMPLETE) ||
116 (chunk == SCTP_AUTHENTICATION)) {
119 if (list->chunks[chunk] == 0) {
120 list->chunks[chunk] = 1;
122 SCTPDBG(SCTP_DEBUG_AUTH1,
123 "SCTP: added chunk %u (0x%02x) to Auth list\n",
130 * delete a chunk from the required chunks list
133 sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t *list)
138 if (list->chunks[chunk] == 1) {
139 list->chunks[chunk] = 0;
141 SCTPDBG(SCTP_DEBUG_AUTH1,
142 "SCTP: deleted chunk %u (0x%02x) from Auth list\n",
149 sctp_auth_get_chklist_size(const sctp_auth_chklist_t *list)
154 return (list->num_chunks);
158 * return the current number and list of required chunks caller must
159 * guarantee ptr has space for up to 256 bytes
162 sctp_serialize_auth_chunks(const sctp_auth_chklist_t *list, uint8_t *ptr)
169 for (i = 0; i < 256; i++) {
170 if (list->chunks[i] != 0) {
179 sctp_pack_auth_chunks(const sctp_auth_chklist_t *list, uint8_t *ptr)
186 if (list->num_chunks <= 32) {
187 /* just list them, one byte each */
188 for (i = 0; i < 256; i++) {
189 if (list->chunks[i] != 0) {
197 /* pack into a 32 byte bitfield */
198 for (i = 0; i < 256; i++) {
199 if (list->chunks[i] != 0) {
202 ptr[index] |= (1 << offset);
211 sctp_unpack_auth_chunks(const uint8_t *ptr, uint8_t num_chunks,
212 sctp_auth_chklist_t *list)
220 if (num_chunks <= 32) {
221 /* just pull them, one byte each */
222 for (i = 0; i < num_chunks; i++) {
223 (void)sctp_auth_add_chunk(*ptr++, list);
229 /* unpack from a 32 byte bitfield */
230 for (index = 0; index < 32; index++) {
231 for (offset = 0; offset < 8; offset++) {
232 if (ptr[index] & (1 << offset)) {
233 (void)sctp_auth_add_chunk((index * 8) + offset, list);
244 * allocate structure space for a key of length keylen
247 sctp_alloc_key(uint32_t keylen)
251 SCTP_MALLOC(new_key, sctp_key_t *, sizeof(*new_key) + keylen,
253 if (new_key == NULL) {
257 new_key->keylen = keylen;
262 sctp_free_key(sctp_key_t *key)
265 SCTP_FREE(key, SCTP_M_AUTH_KY);
269 sctp_print_key(sctp_key_t *key, const char *str)
274 SCTP_PRINTF("%s: [Null key]\n", str);
277 SCTP_PRINTF("%s: len %u, ", str, key->keylen);
279 for (i = 0; i < key->keylen; i++)
280 SCTP_PRINTF("%02x", key->key[i]);
283 SCTP_PRINTF("[Null key]\n");
288 sctp_show_key(sctp_key_t *key, const char *str)
293 SCTP_PRINTF("%s: [Null key]\n", str);
296 SCTP_PRINTF("%s: len %u, ", str, key->keylen);
298 for (i = 0; i < key->keylen; i++)
299 SCTP_PRINTF("%02x", key->key[i]);
302 SCTP_PRINTF("[Null key]\n");
307 sctp_get_keylen(sctp_key_t *key)
310 return (key->keylen);
316 * generate a new random key of length 'keylen'
319 sctp_generate_random_key(uint32_t keylen)
323 new_key = sctp_alloc_key(keylen);
324 if (new_key == NULL) {
328 SCTP_READ_RANDOM(new_key->key, keylen);
329 new_key->keylen = keylen;
334 sctp_set_key(uint8_t *key, uint32_t keylen)
338 new_key = sctp_alloc_key(keylen);
339 if (new_key == NULL) {
343 memcpy(new_key->key, key, keylen);
348 * given two keys of variable size, compute which key is "larger/smaller"
349 * returns: 1 if key1 > key2
354 sctp_compare_key(sctp_key_t *key1, sctp_key_t *key2)
358 uint32_t key1len, key2len;
359 uint8_t *key_1, *key_2;
362 /* sanity/length check */
363 key1len = sctp_get_keylen(key1);
364 key2len = sctp_get_keylen(key2);
365 if ((key1len == 0) && (key2len == 0))
367 else if (key1len == 0)
369 else if (key2len == 0)
372 if (key1len < key2len) {
379 /* check for numeric equality */
380 for (i = 0; i < maxlen; i++) {
381 /* left-pad with zeros */
382 val1 = (i < (maxlen - key1len)) ? 0 : *(key_1++);
383 val2 = (i < (maxlen - key2len)) ? 0 : *(key_2++);
386 } else if (val1 < val2) {
390 /* keys are equal value, so check lengths */
391 if (key1len == key2len)
393 else if (key1len < key2len)
400 * generate the concatenated keying material based on the two keys and the
401 * shared key (if available). draft-ietf-tsvwg-auth specifies the specific
402 * order for concatenation
405 sctp_compute_hashkey(sctp_key_t *key1, sctp_key_t *key2, sctp_key_t *shared)
411 keylen = sctp_get_keylen(key1) + sctp_get_keylen(key2) +
412 sctp_get_keylen(shared);
415 /* get space for the new key */
416 new_key = sctp_alloc_key(keylen);
417 if (new_key == NULL) {
421 new_key->keylen = keylen;
422 key_ptr = new_key->key;
424 /* all keys empty/null?! */
428 /* concatenate the keys */
429 if (sctp_compare_key(key1, key2) <= 0) {
430 /* key is shared + key1 + key2 */
431 if (sctp_get_keylen(shared)) {
432 memcpy(key_ptr, shared->key, shared->keylen);
433 key_ptr += shared->keylen;
435 if (sctp_get_keylen(key1)) {
436 memcpy(key_ptr, key1->key, key1->keylen);
437 key_ptr += key1->keylen;
439 if (sctp_get_keylen(key2)) {
440 memcpy(key_ptr, key2->key, key2->keylen);
443 /* key is shared + key2 + key1 */
444 if (sctp_get_keylen(shared)) {
445 memcpy(key_ptr, shared->key, shared->keylen);
446 key_ptr += shared->keylen;
448 if (sctp_get_keylen(key2)) {
449 memcpy(key_ptr, key2->key, key2->keylen);
450 key_ptr += key2->keylen;
452 if (sctp_get_keylen(key1)) {
453 memcpy(key_ptr, key1->key, key1->keylen);
461 sctp_alloc_sharedkey(void)
463 sctp_sharedkey_t *new_key;
465 SCTP_MALLOC(new_key, sctp_sharedkey_t *, sizeof(*new_key),
467 if (new_key == NULL) {
473 new_key->refcount = 1;
474 new_key->deactivated = 0;
479 sctp_free_sharedkey(sctp_sharedkey_t *skey)
484 if (SCTP_DECREMENT_AND_CHECK_REFCOUNT(&skey->refcount)) {
485 if (skey->key != NULL)
486 sctp_free_key(skey->key);
487 SCTP_FREE(skey, SCTP_M_AUTH_KY);
492 sctp_find_sharedkey(struct sctp_keyhead *shared_keys, uint16_t key_id)
494 sctp_sharedkey_t *skey;
496 LIST_FOREACH(skey, shared_keys, next) {
497 if (skey->keyid == key_id)
504 sctp_insert_sharedkey(struct sctp_keyhead *shared_keys,
505 sctp_sharedkey_t *new_skey)
507 sctp_sharedkey_t *skey;
509 if ((shared_keys == NULL) || (new_skey == NULL))
512 /* insert into an empty list? */
513 if (LIST_EMPTY(shared_keys)) {
514 LIST_INSERT_HEAD(shared_keys, new_skey, next);
517 /* insert into the existing list, ordered by key id */
518 LIST_FOREACH(skey, shared_keys, next) {
519 if (new_skey->keyid < skey->keyid) {
520 /* insert it before here */
521 LIST_INSERT_BEFORE(skey, new_skey, next);
523 } else if (new_skey->keyid == skey->keyid) {
524 /* replace the existing key */
525 /* verify this key *can* be replaced */
526 if ((skey->deactivated) || (skey->refcount > 1)) {
527 SCTPDBG(SCTP_DEBUG_AUTH1,
528 "can't replace shared key id %u\n",
532 SCTPDBG(SCTP_DEBUG_AUTH1,
533 "replacing shared key id %u\n",
535 LIST_INSERT_BEFORE(skey, new_skey, next);
536 LIST_REMOVE(skey, next);
537 sctp_free_sharedkey(skey);
540 if (LIST_NEXT(skey, next) == NULL) {
541 /* belongs at the end of the list */
542 LIST_INSERT_AFTER(skey, new_skey, next);
546 /* shouldn't reach here */
551 sctp_auth_key_acquire(struct sctp_tcb *stcb, uint16_t key_id)
553 sctp_sharedkey_t *skey;
555 /* find the shared key */
556 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, key_id);
558 /* bump the ref count */
560 atomic_add_int(&skey->refcount, 1);
561 SCTPDBG(SCTP_DEBUG_AUTH2,
562 "%s: stcb %p key %u refcount acquire to %d\n",
563 __func__, (void *)stcb, key_id, skey->refcount);
568 sctp_auth_key_release(struct sctp_tcb *stcb, uint16_t key_id, int so_locked)
570 sctp_sharedkey_t *skey;
572 /* find the shared key */
573 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, key_id);
575 /* decrement the ref count */
577 SCTPDBG(SCTP_DEBUG_AUTH2,
578 "%s: stcb %p key %u refcount release to %d\n",
579 __func__, (void *)stcb, key_id, skey->refcount);
581 /* see if a notification should be generated */
582 if ((skey->refcount <= 2) && (skey->deactivated)) {
583 /* notify ULP that key is no longer used */
584 sctp_ulp_notify(SCTP_NOTIFY_AUTH_FREE_KEY, stcb,
585 key_id, 0, so_locked);
586 SCTPDBG(SCTP_DEBUG_AUTH2,
587 "%s: stcb %p key %u no longer used, %d\n",
588 __func__, (void *)stcb, key_id, skey->refcount);
590 sctp_free_sharedkey(skey);
594 static sctp_sharedkey_t *
595 sctp_copy_sharedkey(const sctp_sharedkey_t *skey)
597 sctp_sharedkey_t *new_skey;
601 new_skey = sctp_alloc_sharedkey();
602 if (new_skey == NULL)
604 if (skey->key != NULL)
605 new_skey->key = sctp_set_key(skey->key->key, skey->key->keylen);
607 new_skey->key = NULL;
608 new_skey->keyid = skey->keyid;
613 sctp_copy_skeylist(const struct sctp_keyhead *src, struct sctp_keyhead *dest)
615 sctp_sharedkey_t *skey, *new_skey;
618 if ((src == NULL) || (dest == NULL))
620 LIST_FOREACH(skey, src, next) {
621 new_skey = sctp_copy_sharedkey(skey);
622 if (new_skey != NULL) {
623 if (sctp_insert_sharedkey(dest, new_skey)) {
624 sctp_free_sharedkey(new_skey);
635 sctp_alloc_hmaclist(uint16_t num_hmacs)
637 sctp_hmaclist_t *new_list;
640 alloc_size = sizeof(*new_list) + num_hmacs * sizeof(new_list->hmac[0]);
641 SCTP_MALLOC(new_list, sctp_hmaclist_t *, alloc_size,
643 if (new_list == NULL) {
647 new_list->max_algo = num_hmacs;
648 new_list->num_algo = 0;
653 sctp_free_hmaclist(sctp_hmaclist_t *list)
656 SCTP_FREE(list, SCTP_M_AUTH_HL);
661 sctp_auth_add_hmacid(sctp_hmaclist_t *list, uint16_t hmac_id)
667 if (list->num_algo == list->max_algo) {
668 SCTPDBG(SCTP_DEBUG_AUTH1,
669 "SCTP: HMAC id list full, ignoring add %u\n", hmac_id);
672 if ((hmac_id != SCTP_AUTH_HMAC_ID_SHA1) &&
673 (hmac_id != SCTP_AUTH_HMAC_ID_SHA256)) {
676 /* Now is it already in the list */
677 for (i = 0; i < list->num_algo; i++) {
678 if (list->hmac[i] == hmac_id) {
679 /* already in list */
683 SCTPDBG(SCTP_DEBUG_AUTH1, "SCTP: add HMAC id %u to list\n", hmac_id);
684 list->hmac[list->num_algo++] = hmac_id;
689 sctp_copy_hmaclist(sctp_hmaclist_t *list)
691 sctp_hmaclist_t *new_list;
697 new_list = sctp_alloc_hmaclist(list->max_algo);
698 if (new_list == NULL)
701 new_list->max_algo = list->max_algo;
702 new_list->num_algo = list->num_algo;
703 for (i = 0; i < list->num_algo; i++)
704 new_list->hmac[i] = list->hmac[i];
709 sctp_default_supported_hmaclist(void)
711 sctp_hmaclist_t *new_list;
713 new_list = sctp_alloc_hmaclist(2);
714 if (new_list == NULL)
716 /* We prefer SHA256, so list it first */
717 (void)sctp_auth_add_hmacid(new_list, SCTP_AUTH_HMAC_ID_SHA256);
718 (void)sctp_auth_add_hmacid(new_list, SCTP_AUTH_HMAC_ID_SHA1);
723 * HMAC algos are listed in priority/preference order
724 * find the best HMAC id to use for the peer based on local support
727 sctp_negotiate_hmacid(sctp_hmaclist_t *peer, sctp_hmaclist_t *local)
731 if ((local == NULL) || (peer == NULL))
732 return (SCTP_AUTH_HMAC_ID_RSVD);
734 for (i = 0; i < peer->num_algo; i++) {
735 for (j = 0; j < local->num_algo; j++) {
736 if (peer->hmac[i] == local->hmac[j]) {
737 /* found the "best" one */
738 SCTPDBG(SCTP_DEBUG_AUTH1,
739 "SCTP: negotiated peer HMAC id %u\n",
741 return (peer->hmac[i]);
745 /* didn't find one! */
746 return (SCTP_AUTH_HMAC_ID_RSVD);
750 * serialize the HMAC algo list and return space used
751 * caller must guarantee ptr has appropriate space
754 sctp_serialize_hmaclist(sctp_hmaclist_t *list, uint8_t *ptr)
762 for (i = 0; i < list->num_algo; i++) {
763 hmac_id = htons(list->hmac[i]);
764 memcpy(ptr, &hmac_id, sizeof(hmac_id));
765 ptr += sizeof(hmac_id);
767 return (list->num_algo * sizeof(hmac_id));
771 sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs, uint32_t num_hmacs)
775 for (i = 0; i < num_hmacs; i++) {
776 if (ntohs(hmacs->hmac_ids[i]) == SCTP_AUTH_HMAC_ID_SHA1) {
784 sctp_alloc_authinfo(void)
786 sctp_authinfo_t *new_authinfo;
788 SCTP_MALLOC(new_authinfo, sctp_authinfo_t *, sizeof(*new_authinfo),
791 if (new_authinfo == NULL) {
795 memset(new_authinfo, 0, sizeof(*new_authinfo));
796 return (new_authinfo);
800 sctp_free_authinfo(sctp_authinfo_t *authinfo)
802 if (authinfo == NULL)
805 if (authinfo->random != NULL)
806 sctp_free_key(authinfo->random);
807 if (authinfo->peer_random != NULL)
808 sctp_free_key(authinfo->peer_random);
809 if (authinfo->assoc_key != NULL)
810 sctp_free_key(authinfo->assoc_key);
811 if (authinfo->recv_key != NULL)
812 sctp_free_key(authinfo->recv_key);
814 /* We are NOT dynamically allocating authinfo's right now... */
815 /* SCTP_FREE(authinfo, SCTP_M_AUTH_??); */
820 sctp_get_auth_chunk_len(uint16_t hmac_algo)
824 size = sizeof(struct sctp_auth_chunk) + sctp_get_hmac_digest_len(hmac_algo);
825 return (SCTP_SIZE32(size));
829 sctp_get_hmac_digest_len(uint16_t hmac_algo)
832 case SCTP_AUTH_HMAC_ID_SHA1:
833 return (SCTP_AUTH_DIGEST_LEN_SHA1);
834 case SCTP_AUTH_HMAC_ID_SHA256:
835 return (SCTP_AUTH_DIGEST_LEN_SHA256);
837 /* unknown HMAC algorithm: can't do anything */
843 sctp_get_hmac_block_len(uint16_t hmac_algo)
846 case SCTP_AUTH_HMAC_ID_SHA1:
848 case SCTP_AUTH_HMAC_ID_SHA256:
850 case SCTP_AUTH_HMAC_ID_RSVD:
852 /* unknown HMAC algorithm: can't do anything */
858 sctp_hmac_init(uint16_t hmac_algo, sctp_hash_context_t *ctx)
861 case SCTP_AUTH_HMAC_ID_SHA1:
862 SCTP_SHA1_INIT(&ctx->sha1);
864 case SCTP_AUTH_HMAC_ID_SHA256:
865 SCTP_SHA256_INIT(&ctx->sha256);
867 case SCTP_AUTH_HMAC_ID_RSVD:
869 /* unknown HMAC algorithm: can't do anything */
875 sctp_hmac_update(uint16_t hmac_algo, sctp_hash_context_t *ctx,
876 uint8_t *text, uint32_t textlen)
879 case SCTP_AUTH_HMAC_ID_SHA1:
880 SCTP_SHA1_UPDATE(&ctx->sha1, text, textlen);
882 case SCTP_AUTH_HMAC_ID_SHA256:
883 SCTP_SHA256_UPDATE(&ctx->sha256, text, textlen);
885 case SCTP_AUTH_HMAC_ID_RSVD:
887 /* unknown HMAC algorithm: can't do anything */
893 sctp_hmac_final(uint16_t hmac_algo, sctp_hash_context_t *ctx,
897 case SCTP_AUTH_HMAC_ID_SHA1:
898 SCTP_SHA1_FINAL(digest, &ctx->sha1);
900 case SCTP_AUTH_HMAC_ID_SHA256:
901 SCTP_SHA256_FINAL(digest, &ctx->sha256);
903 case SCTP_AUTH_HMAC_ID_RSVD:
905 /* unknown HMAC algorithm: can't do anything */
911 * Keyed-Hashing for Message Authentication: FIPS 198 (RFC 2104)
913 * Compute the HMAC digest using the desired hash key, text, and HMAC
914 * algorithm. Resulting digest is placed in 'digest' and digest length
915 * is returned, if the HMAC was performed.
917 * WARNING: it is up to the caller to supply sufficient space to hold the
921 sctp_hmac(uint16_t hmac_algo, uint8_t *key, uint32_t keylen,
922 uint8_t *text, uint32_t textlen, uint8_t *digest)
926 sctp_hash_context_t ctx;
927 uint8_t ipad[128], opad[128]; /* keyed hash inner/outer pads */
928 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
931 /* sanity check the material and length */
932 if ((key == NULL) || (keylen == 0) || (text == NULL) ||
933 (textlen == 0) || (digest == NULL)) {
934 /* can't do HMAC with empty key or text or digest store */
937 /* validate the hmac algo and get the digest length */
938 digestlen = sctp_get_hmac_digest_len(hmac_algo);
942 /* hash the key if it is longer than the hash block size */
943 blocklen = sctp_get_hmac_block_len(hmac_algo);
944 if (keylen > blocklen) {
945 sctp_hmac_init(hmac_algo, &ctx);
946 sctp_hmac_update(hmac_algo, &ctx, key, keylen);
947 sctp_hmac_final(hmac_algo, &ctx, temp);
948 /* set the hashed key as the key */
952 /* initialize the inner/outer pads with the key and "append" zeroes */
953 memset(ipad, 0, blocklen);
954 memset(opad, 0, blocklen);
955 memcpy(ipad, key, keylen);
956 memcpy(opad, key, keylen);
958 /* XOR the key with ipad and opad values */
959 for (i = 0; i < blocklen; i++) {
964 /* perform inner hash */
965 sctp_hmac_init(hmac_algo, &ctx);
966 sctp_hmac_update(hmac_algo, &ctx, ipad, blocklen);
967 sctp_hmac_update(hmac_algo, &ctx, text, textlen);
968 sctp_hmac_final(hmac_algo, &ctx, temp);
970 /* perform outer hash */
971 sctp_hmac_init(hmac_algo, &ctx);
972 sctp_hmac_update(hmac_algo, &ctx, opad, blocklen);
973 sctp_hmac_update(hmac_algo, &ctx, temp, digestlen);
974 sctp_hmac_final(hmac_algo, &ctx, digest);
981 sctp_hmac_m(uint16_t hmac_algo, uint8_t *key, uint32_t keylen,
982 struct mbuf *m, uint32_t m_offset, uint8_t *digest, uint32_t trailer)
986 sctp_hash_context_t ctx;
987 uint8_t ipad[128], opad[128]; /* keyed hash inner/outer pads */
988 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
992 /* sanity check the material and length */
993 if ((key == NULL) || (keylen == 0) || (m == NULL) || (digest == NULL)) {
994 /* can't do HMAC with empty key or text or digest store */
997 /* validate the hmac algo and get the digest length */
998 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1002 /* hash the key if it is longer than the hash block size */
1003 blocklen = sctp_get_hmac_block_len(hmac_algo);
1004 if (keylen > blocklen) {
1005 sctp_hmac_init(hmac_algo, &ctx);
1006 sctp_hmac_update(hmac_algo, &ctx, key, keylen);
1007 sctp_hmac_final(hmac_algo, &ctx, temp);
1008 /* set the hashed key as the key */
1012 /* initialize the inner/outer pads with the key and "append" zeroes */
1013 memset(ipad, 0, blocklen);
1014 memset(opad, 0, blocklen);
1015 memcpy(ipad, key, keylen);
1016 memcpy(opad, key, keylen);
1018 /* XOR the key with ipad and opad values */
1019 for (i = 0; i < blocklen; i++) {
1024 /* perform inner hash */
1025 sctp_hmac_init(hmac_algo, &ctx);
1026 sctp_hmac_update(hmac_algo, &ctx, ipad, blocklen);
1027 /* find the correct starting mbuf and offset (get start of text) */
1029 while ((m_tmp != NULL) && (m_offset >= (uint32_t)SCTP_BUF_LEN(m_tmp))) {
1030 m_offset -= SCTP_BUF_LEN(m_tmp);
1031 m_tmp = SCTP_BUF_NEXT(m_tmp);
1033 /* now use the rest of the mbuf chain for the text */
1034 while (m_tmp != NULL) {
1035 if ((SCTP_BUF_NEXT(m_tmp) == NULL) && trailer) {
1036 sctp_hmac_update(hmac_algo, &ctx, mtod(m_tmp, uint8_t *)+m_offset,
1037 SCTP_BUF_LEN(m_tmp) - (trailer + m_offset));
1039 sctp_hmac_update(hmac_algo, &ctx, mtod(m_tmp, uint8_t *)+m_offset,
1040 SCTP_BUF_LEN(m_tmp) - m_offset);
1043 /* clear the offset since it's only for the first mbuf */
1045 m_tmp = SCTP_BUF_NEXT(m_tmp);
1047 sctp_hmac_final(hmac_algo, &ctx, temp);
1049 /* perform outer hash */
1050 sctp_hmac_init(hmac_algo, &ctx);
1051 sctp_hmac_update(hmac_algo, &ctx, opad, blocklen);
1052 sctp_hmac_update(hmac_algo, &ctx, temp, digestlen);
1053 sctp_hmac_final(hmac_algo, &ctx, digest);
1059 * computes the requested HMAC using a key struct (which may be modified if
1060 * the keylen exceeds the HMAC block len).
1063 sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t *key, uint8_t *text,
1064 uint32_t textlen, uint8_t *digest)
1068 sctp_hash_context_t ctx;
1069 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
1072 if ((key == NULL) || (text == NULL) || (textlen == 0) ||
1074 /* can't do HMAC with empty key or text or digest store */
1077 /* validate the hmac algo and get the digest length */
1078 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1082 /* hash the key if it is longer than the hash block size */
1083 blocklen = sctp_get_hmac_block_len(hmac_algo);
1084 if (key->keylen > blocklen) {
1085 sctp_hmac_init(hmac_algo, &ctx);
1086 sctp_hmac_update(hmac_algo, &ctx, key->key, key->keylen);
1087 sctp_hmac_final(hmac_algo, &ctx, temp);
1088 /* save the hashed key as the new key */
1089 key->keylen = digestlen;
1090 memcpy(key->key, temp, key->keylen);
1092 return (sctp_hmac(hmac_algo, key->key, key->keylen, text, textlen,
1098 sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t *key, struct mbuf *m,
1099 uint32_t m_offset, uint8_t *digest)
1103 sctp_hash_context_t ctx;
1104 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
1107 if ((key == NULL) || (m == NULL) || (digest == NULL)) {
1108 /* can't do HMAC with empty key or text or digest store */
1111 /* validate the hmac algo and get the digest length */
1112 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1116 /* hash the key if it is longer than the hash block size */
1117 blocklen = sctp_get_hmac_block_len(hmac_algo);
1118 if (key->keylen > blocklen) {
1119 sctp_hmac_init(hmac_algo, &ctx);
1120 sctp_hmac_update(hmac_algo, &ctx, key->key, key->keylen);
1121 sctp_hmac_final(hmac_algo, &ctx, temp);
1122 /* save the hashed key as the new key */
1123 key->keylen = digestlen;
1124 memcpy(key->key, temp, key->keylen);
1126 return (sctp_hmac_m(hmac_algo, key->key, key->keylen, m, m_offset, digest, 0));
1130 sctp_auth_is_supported_hmac(sctp_hmaclist_t *list, uint16_t id)
1134 if ((list == NULL) || (id == SCTP_AUTH_HMAC_ID_RSVD))
1137 for (i = 0; i < list->num_algo; i++)
1138 if (list->hmac[i] == id)
1141 /* not in the list */
1147 * clear any cached key(s) if they match the given key id on an association.
1148 * the cached key(s) will be recomputed and re-cached at next use.
1149 * ASSUMES TCB_LOCK is already held
1152 sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid)
1157 if (keyid == stcb->asoc.authinfo.assoc_keyid) {
1158 sctp_free_key(stcb->asoc.authinfo.assoc_key);
1159 stcb->asoc.authinfo.assoc_key = NULL;
1161 if (keyid == stcb->asoc.authinfo.recv_keyid) {
1162 sctp_free_key(stcb->asoc.authinfo.recv_key);
1163 stcb->asoc.authinfo.recv_key = NULL;
1168 * clear any cached key(s) if they match the given key id for all assocs on
1170 * ASSUMES INP_WLOCK is already held
1173 sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid)
1175 struct sctp_tcb *stcb;
1180 /* clear the cached keys on all assocs on this instance */
1181 LIST_FOREACH(stcb, &inp->sctp_asoc_list, sctp_tcblist) {
1182 SCTP_TCB_LOCK(stcb);
1183 sctp_clear_cachedkeys(stcb, keyid);
1184 SCTP_TCB_UNLOCK(stcb);
1189 * delete a shared key from an association
1190 * ASSUMES TCB_LOCK is already held
1193 sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid)
1195 sctp_sharedkey_t *skey;
1200 /* is the keyid the assoc active sending key */
1201 if (keyid == stcb->asoc.authinfo.active_keyid)
1204 /* does the key exist? */
1205 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1209 /* are there other refcount holders on the key? */
1210 if (skey->refcount > 1)
1214 LIST_REMOVE(skey, next);
1215 sctp_free_sharedkey(skey); /* frees skey->key as well */
1217 /* clear any cached keys */
1218 sctp_clear_cachedkeys(stcb, keyid);
1223 * deletes a shared key from the endpoint
1224 * ASSUMES INP_WLOCK is already held
1227 sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1229 sctp_sharedkey_t *skey;
1234 /* is the keyid the active sending key on the endpoint */
1235 if (keyid == inp->sctp_ep.default_keyid)
1238 /* does the key exist? */
1239 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1243 /* endpoint keys are not refcounted */
1246 LIST_REMOVE(skey, next);
1247 sctp_free_sharedkey(skey); /* frees skey->key as well */
1249 /* clear any cached keys */
1250 sctp_clear_cachedkeys_ep(inp, keyid);
1255 * set the active key on an association
1256 * ASSUMES TCB_LOCK is already held
1259 sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid)
1261 sctp_sharedkey_t *skey = NULL;
1263 /* find the key on the assoc */
1264 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1266 /* that key doesn't exist */
1269 if ((skey->deactivated) && (skey->refcount > 1)) {
1270 /* can't reactivate a deactivated key with other refcounts */
1274 /* set the (new) active key */
1275 stcb->asoc.authinfo.active_keyid = keyid;
1276 /* reset the deactivated flag */
1277 skey->deactivated = 0;
1283 * set the active key on an endpoint
1284 * ASSUMES INP_WLOCK is already held
1287 sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1289 sctp_sharedkey_t *skey;
1292 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1294 /* that key doesn't exist */
1297 inp->sctp_ep.default_keyid = keyid;
1302 * deactivates a shared key from the association
1303 * ASSUMES INP_WLOCK is already held
1306 sctp_deact_sharedkey(struct sctp_tcb *stcb, uint16_t keyid)
1308 sctp_sharedkey_t *skey;
1313 /* is the keyid the assoc active sending key */
1314 if (keyid == stcb->asoc.authinfo.active_keyid)
1317 /* does the key exist? */
1318 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1322 /* are there other refcount holders on the key? */
1323 if (skey->refcount == 1) {
1324 /* no other users, send a notification for this key */
1325 sctp_ulp_notify(SCTP_NOTIFY_AUTH_FREE_KEY, stcb, keyid, 0,
1329 /* mark the key as deactivated */
1330 skey->deactivated = 1;
1336 * deactivates a shared key from the endpoint
1337 * ASSUMES INP_WLOCK is already held
1340 sctp_deact_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1342 sctp_sharedkey_t *skey;
1347 /* is the keyid the active sending key on the endpoint */
1348 if (keyid == inp->sctp_ep.default_keyid)
1351 /* does the key exist? */
1352 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1356 /* endpoint keys are not refcounted */
1359 LIST_REMOVE(skey, next);
1360 sctp_free_sharedkey(skey); /* frees skey->key as well */
1366 * get local authentication parameters from cookie (from INIT-ACK)
1369 sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m,
1370 uint32_t offset, uint32_t length)
1372 struct sctp_paramhdr *phdr, tmp_param;
1373 uint16_t plen, ptype;
1374 uint8_t random_store[SCTP_PARAM_BUFFER_SIZE];
1375 struct sctp_auth_random *p_random = NULL;
1376 uint16_t random_len = 0;
1377 uint8_t hmacs_store[SCTP_PARAM_BUFFER_SIZE];
1378 struct sctp_auth_hmac_algo *hmacs = NULL;
1379 uint16_t hmacs_len = 0;
1380 uint8_t chunks_store[SCTP_PARAM_BUFFER_SIZE];
1381 struct sctp_auth_chunk_list *chunks = NULL;
1382 uint16_t num_chunks = 0;
1383 sctp_key_t *new_key;
1386 /* convert to upper bound */
1389 phdr = (struct sctp_paramhdr *)sctp_m_getptr(m, offset,
1390 sizeof(struct sctp_paramhdr), (uint8_t *)&tmp_param);
1391 while (phdr != NULL) {
1392 ptype = ntohs(phdr->param_type);
1393 plen = ntohs(phdr->param_length);
1395 if ((plen < sizeof(struct sctp_paramhdr)) ||
1396 (offset + plen > length))
1399 if (ptype == SCTP_RANDOM) {
1400 if (plen > sizeof(random_store))
1402 phdr = sctp_get_next_param(m, offset,
1403 (struct sctp_paramhdr *)random_store, plen);
1406 /* save the random and length for the key */
1407 p_random = (struct sctp_auth_random *)phdr;
1408 random_len = plen - sizeof(*p_random);
1409 } else if (ptype == SCTP_HMAC_LIST) {
1413 if (plen > sizeof(hmacs_store))
1415 phdr = sctp_get_next_param(m, offset,
1416 (struct sctp_paramhdr *)hmacs_store, plen);
1419 /* save the hmacs list and num for the key */
1420 hmacs = (struct sctp_auth_hmac_algo *)phdr;
1421 hmacs_len = plen - sizeof(*hmacs);
1422 num_hmacs = hmacs_len / sizeof(hmacs->hmac_ids[0]);
1423 if (stcb->asoc.local_hmacs != NULL)
1424 sctp_free_hmaclist(stcb->asoc.local_hmacs);
1425 stcb->asoc.local_hmacs = sctp_alloc_hmaclist(num_hmacs);
1426 if (stcb->asoc.local_hmacs != NULL) {
1427 for (i = 0; i < num_hmacs; i++) {
1428 (void)sctp_auth_add_hmacid(stcb->asoc.local_hmacs,
1429 ntohs(hmacs->hmac_ids[i]));
1432 } else if (ptype == SCTP_CHUNK_LIST) {
1435 if (plen > sizeof(chunks_store))
1437 phdr = sctp_get_next_param(m, offset,
1438 (struct sctp_paramhdr *)chunks_store, plen);
1441 chunks = (struct sctp_auth_chunk_list *)phdr;
1442 num_chunks = plen - sizeof(*chunks);
1443 /* save chunks list and num for the key */
1444 if (stcb->asoc.local_auth_chunks != NULL)
1445 sctp_clear_chunklist(stcb->asoc.local_auth_chunks);
1447 stcb->asoc.local_auth_chunks = sctp_alloc_chunklist();
1448 for (i = 0; i < num_chunks; i++) {
1449 (void)sctp_auth_add_chunk(chunks->chunk_types[i],
1450 stcb->asoc.local_auth_chunks);
1453 /* get next parameter */
1454 offset += SCTP_SIZE32(plen);
1455 if (offset + sizeof(struct sctp_paramhdr) > length)
1457 phdr = (struct sctp_paramhdr *)sctp_m_getptr(m, offset, sizeof(struct sctp_paramhdr),
1458 (uint8_t *)&tmp_param);
1460 /* concatenate the full random key */
1461 keylen = sizeof(*p_random) + random_len + sizeof(*hmacs) + hmacs_len;
1462 if (chunks != NULL) {
1463 keylen += sizeof(*chunks) + num_chunks;
1465 new_key = sctp_alloc_key(keylen);
1466 if (new_key != NULL) {
1467 /* copy in the RANDOM */
1468 if (p_random != NULL) {
1469 keylen = sizeof(*p_random) + random_len;
1470 memcpy(new_key->key, p_random, keylen);
1474 /* append in the AUTH chunks */
1475 if (chunks != NULL) {
1476 memcpy(new_key->key + keylen, chunks,
1477 sizeof(*chunks) + num_chunks);
1478 keylen += sizeof(*chunks) + num_chunks;
1480 /* append in the HMACs */
1481 if (hmacs != NULL) {
1482 memcpy(new_key->key + keylen, hmacs,
1483 sizeof(*hmacs) + hmacs_len);
1486 if (stcb->asoc.authinfo.random != NULL)
1487 sctp_free_key(stcb->asoc.authinfo.random);
1488 stcb->asoc.authinfo.random = new_key;
1489 stcb->asoc.authinfo.random_len = random_len;
1490 sctp_clear_cachedkeys(stcb, stcb->asoc.authinfo.assoc_keyid);
1491 sctp_clear_cachedkeys(stcb, stcb->asoc.authinfo.recv_keyid);
1493 /* negotiate what HMAC to use for the peer */
1494 stcb->asoc.peer_hmac_id = sctp_negotiate_hmacid(stcb->asoc.peer_hmacs,
1495 stcb->asoc.local_hmacs);
1497 /* copy defaults from the endpoint */
1498 /* FIX ME: put in cookie? */
1499 stcb->asoc.authinfo.active_keyid = stcb->sctp_ep->sctp_ep.default_keyid;
1500 /* copy out the shared key list (by reference) from the endpoint */
1501 (void)sctp_copy_skeylist(&stcb->sctp_ep->sctp_ep.shared_keys,
1502 &stcb->asoc.shared_keys);
1506 * compute and fill in the HMAC digest for a packet
1509 sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset,
1510 struct sctp_auth_chunk *auth, struct sctp_tcb *stcb, uint16_t keyid)
1513 sctp_sharedkey_t *skey;
1516 if ((stcb == NULL) || (auth == NULL))
1519 /* zero the digest + chunk padding */
1520 digestlen = sctp_get_hmac_digest_len(stcb->asoc.peer_hmac_id);
1521 memset(auth->hmac, 0, SCTP_SIZE32(digestlen));
1523 /* is the desired key cached? */
1524 if ((keyid != stcb->asoc.authinfo.assoc_keyid) ||
1525 (stcb->asoc.authinfo.assoc_key == NULL)) {
1526 if (stcb->asoc.authinfo.assoc_key != NULL) {
1527 /* free the old cached key */
1528 sctp_free_key(stcb->asoc.authinfo.assoc_key);
1530 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1531 /* the only way skey is NULL is if null key id 0 is used */
1536 /* compute a new assoc key and cache it */
1537 stcb->asoc.authinfo.assoc_key =
1538 sctp_compute_hashkey(stcb->asoc.authinfo.random,
1539 stcb->asoc.authinfo.peer_random, key);
1540 stcb->asoc.authinfo.assoc_keyid = keyid;
1541 SCTPDBG(SCTP_DEBUG_AUTH1, "caching key id %u\n",
1542 stcb->asoc.authinfo.assoc_keyid);
1544 if (SCTP_AUTH_DEBUG)
1545 sctp_print_key(stcb->asoc.authinfo.assoc_key,
1550 /* set in the active key id */
1551 auth->shared_key_id = htons(keyid);
1553 /* compute and fill in the digest */
1554 (void)sctp_compute_hmac_m(stcb->asoc.peer_hmac_id, stcb->asoc.authinfo.assoc_key,
1555 m, auth_offset, auth->hmac);
1560 sctp_zero_m(struct mbuf *m, uint32_t m_offset, uint32_t size)
1569 /* find the correct starting mbuf and offset (get start position) */
1571 while ((m_tmp != NULL) && (m_offset >= (uint32_t)SCTP_BUF_LEN(m_tmp))) {
1572 m_offset -= SCTP_BUF_LEN(m_tmp);
1573 m_tmp = SCTP_BUF_NEXT(m_tmp);
1575 /* now use the rest of the mbuf chain */
1576 while ((m_tmp != NULL) && (size > 0)) {
1577 data = mtod(m_tmp, uint8_t *)+m_offset;
1578 if (size > (uint32_t)(SCTP_BUF_LEN(m_tmp) - m_offset)) {
1579 memset(data, 0, SCTP_BUF_LEN(m_tmp) - m_offset);
1580 size -= SCTP_BUF_LEN(m_tmp) - m_offset;
1582 memset(data, 0, size);
1585 /* clear the offset since it's only for the first mbuf */
1587 m_tmp = SCTP_BUF_NEXT(m_tmp);
1592 * process the incoming Authentication chunk
1594 * -1 on any authentication error
1595 * 0 on authentication verification
1598 sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *auth,
1599 struct mbuf *m, uint32_t offset)
1602 uint16_t shared_key_id;
1604 sctp_sharedkey_t *skey;
1606 uint8_t digest[SCTP_AUTH_DIGEST_LEN_MAX];
1607 uint8_t computed_digest[SCTP_AUTH_DIGEST_LEN_MAX];
1609 /* auth is checked for NULL by caller */
1610 chunklen = ntohs(auth->ch.chunk_length);
1611 if (chunklen < sizeof(*auth)) {
1612 SCTP_STAT_INCR(sctps_recvauthfailed);
1615 SCTP_STAT_INCR(sctps_recvauth);
1617 /* get the auth params */
1618 shared_key_id = ntohs(auth->shared_key_id);
1619 hmac_id = ntohs(auth->hmac_id);
1620 SCTPDBG(SCTP_DEBUG_AUTH1,
1621 "SCTP AUTH Chunk: shared key %u, HMAC id %u\n",
1622 shared_key_id, hmac_id);
1624 /* is the indicated HMAC supported? */
1625 if (!sctp_auth_is_supported_hmac(stcb->asoc.local_hmacs, hmac_id)) {
1626 struct mbuf *op_err;
1627 struct sctp_error_auth_invalid_hmac *cause;
1629 SCTP_STAT_INCR(sctps_recvivalhmacid);
1630 SCTPDBG(SCTP_DEBUG_AUTH1,
1631 "SCTP Auth: unsupported HMAC id %u\n",
1634 * report this in an Error Chunk: Unsupported HMAC
1637 op_err = sctp_get_mbuf_for_msg(sizeof(struct sctp_error_auth_invalid_hmac),
1638 0, M_NOWAIT, 1, MT_HEADER);
1639 if (op_err != NULL) {
1640 /* pre-reserve some space */
1641 SCTP_BUF_RESV_UF(op_err, sizeof(struct sctp_chunkhdr));
1642 /* fill in the error */
1643 cause = mtod(op_err, struct sctp_error_auth_invalid_hmac *);
1644 cause->cause.code = htons(SCTP_CAUSE_UNSUPPORTED_HMACID);
1645 cause->cause.length = htons(sizeof(struct sctp_error_auth_invalid_hmac));
1646 cause->hmac_id = ntohs(hmac_id);
1647 SCTP_BUF_LEN(op_err) = sizeof(struct sctp_error_auth_invalid_hmac);
1649 sctp_queue_op_err(stcb, op_err);
1653 /* get the indicated shared key, if available */
1654 if ((stcb->asoc.authinfo.recv_key == NULL) ||
1655 (stcb->asoc.authinfo.recv_keyid != shared_key_id)) {
1656 /* find the shared key on the assoc first */
1657 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys,
1659 /* if the shared key isn't found, discard the chunk */
1661 SCTP_STAT_INCR(sctps_recvivalkeyid);
1662 SCTPDBG(SCTP_DEBUG_AUTH1,
1663 "SCTP Auth: unknown key id %u\n",
1667 /* generate a notification if this is a new key id */
1668 if (stcb->asoc.authinfo.recv_keyid != shared_key_id)
1670 * sctp_ulp_notify(SCTP_NOTIFY_AUTH_NEW_KEY, stcb,
1671 * shared_key_id, (void
1672 * *)stcb->asoc.authinfo.recv_keyid);
1674 sctp_notify_authentication(stcb, SCTP_AUTH_NEW_KEY,
1675 shared_key_id, stcb->asoc.authinfo.recv_keyid,
1676 SCTP_SO_NOT_LOCKED);
1677 /* compute a new recv assoc key and cache it */
1678 if (stcb->asoc.authinfo.recv_key != NULL)
1679 sctp_free_key(stcb->asoc.authinfo.recv_key);
1680 stcb->asoc.authinfo.recv_key =
1681 sctp_compute_hashkey(stcb->asoc.authinfo.random,
1682 stcb->asoc.authinfo.peer_random, skey->key);
1683 stcb->asoc.authinfo.recv_keyid = shared_key_id;
1685 if (SCTP_AUTH_DEBUG)
1686 sctp_print_key(stcb->asoc.authinfo.recv_key, "Recv Key");
1689 /* validate the digest length */
1690 digestlen = sctp_get_hmac_digest_len(hmac_id);
1691 if (chunklen < (sizeof(*auth) + digestlen)) {
1692 /* invalid digest length */
1693 SCTP_STAT_INCR(sctps_recvauthfailed);
1694 SCTPDBG(SCTP_DEBUG_AUTH1,
1695 "SCTP Auth: chunk too short for HMAC\n");
1698 /* save a copy of the digest, zero the pseudo header, and validate */
1699 memcpy(digest, auth->hmac, digestlen);
1700 sctp_zero_m(m, offset + sizeof(*auth), SCTP_SIZE32(digestlen));
1701 (void)sctp_compute_hmac_m(hmac_id, stcb->asoc.authinfo.recv_key,
1702 m, offset, computed_digest);
1704 /* compare the computed digest with the one in the AUTH chunk */
1705 if (timingsafe_bcmp(digest, computed_digest, digestlen) != 0) {
1706 SCTP_STAT_INCR(sctps_recvauthfailed);
1707 SCTPDBG(SCTP_DEBUG_AUTH1,
1708 "SCTP Auth: HMAC digest check failed\n");
1715 * Generate NOTIFICATION
1718 sctp_notify_authentication(struct sctp_tcb *stcb, uint32_t indication,
1719 uint16_t keyid, uint16_t alt_keyid, int so_locked)
1721 struct mbuf *m_notify;
1722 struct sctp_authkey_event *auth;
1723 struct sctp_queued_to_read *control;
1725 if ((stcb == NULL) ||
1726 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_SOCKET_GONE) ||
1727 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_SOCKET_ALLGONE) ||
1728 (stcb->asoc.state & SCTP_STATE_CLOSED_SOCKET)
1730 /* If the socket is gone we are out of here */
1734 if (sctp_stcb_is_feature_off(stcb->sctp_ep, stcb, SCTP_PCB_FLAGS_AUTHEVNT))
1735 /* event not enabled */
1738 m_notify = sctp_get_mbuf_for_msg(sizeof(struct sctp_authkey_event),
1739 0, M_NOWAIT, 1, MT_HEADER);
1740 if (m_notify == NULL)
1744 SCTP_BUF_LEN(m_notify) = 0;
1745 auth = mtod(m_notify, struct sctp_authkey_event *);
1746 memset(auth, 0, sizeof(struct sctp_authkey_event));
1747 auth->auth_type = SCTP_AUTHENTICATION_EVENT;
1748 auth->auth_flags = 0;
1749 auth->auth_length = sizeof(*auth);
1750 auth->auth_keynumber = keyid;
1751 auth->auth_altkeynumber = alt_keyid;
1752 auth->auth_indication = indication;
1753 auth->auth_assoc_id = sctp_get_associd(stcb);
1755 SCTP_BUF_LEN(m_notify) = sizeof(*auth);
1756 SCTP_BUF_NEXT(m_notify) = NULL;
1758 /* append to socket */
1759 control = sctp_build_readq_entry(stcb, stcb->asoc.primary_destination,
1760 0, 0, stcb->asoc.context, 0, 0, 0, m_notify);
1761 if (control == NULL) {
1763 sctp_m_freem(m_notify);
1766 control->length = SCTP_BUF_LEN(m_notify);
1767 control->spec_flags = M_NOTIFICATION;
1768 /* not that we need this */
1769 control->tail_mbuf = m_notify;
1770 sctp_add_to_readq(stcb->sctp_ep, stcb, control,
1771 &stcb->sctp_socket->so_rcv, 1, SCTP_READ_LOCK_NOT_HELD, so_locked);
1776 * validates the AUTHentication related parameters in an INIT/INIT-ACK
1777 * Note: currently only used for INIT as INIT-ACK is handled inline
1778 * with sctp_load_addresses_from_init()
1781 sctp_validate_init_auth_params(struct mbuf *m, int offset, int limit)
1783 struct sctp_paramhdr *phdr, param_buf;
1784 uint16_t ptype, plen;
1785 int peer_supports_asconf = 0;
1786 int peer_supports_auth = 0;
1787 int got_random = 0, got_hmacs = 0, got_chklist = 0;
1788 uint8_t saw_asconf = 0;
1789 uint8_t saw_asconf_ack = 0;
1791 /* go through each of the params. */
1792 phdr = sctp_get_next_param(m, offset, ¶m_buf, sizeof(param_buf));
1794 ptype = ntohs(phdr->param_type);
1795 plen = ntohs(phdr->param_length);
1797 if (offset + plen > limit) {
1800 if (plen < sizeof(struct sctp_paramhdr)) {
1803 if (ptype == SCTP_SUPPORTED_CHUNK_EXT) {
1804 /* A supported extension chunk */
1805 struct sctp_supported_chunk_types_param *pr_supported;
1806 uint8_t local_store[SCTP_SMALL_CHUNK_STORE];
1809 if (plen > sizeof(local_store)) {
1812 phdr = sctp_get_next_param(m, offset,
1813 (struct sctp_paramhdr *)&local_store,
1818 pr_supported = (struct sctp_supported_chunk_types_param *)phdr;
1819 num_ent = plen - sizeof(struct sctp_paramhdr);
1820 for (i = 0; i < num_ent; i++) {
1821 switch (pr_supported->chunk_types[i]) {
1823 case SCTP_ASCONF_ACK:
1824 peer_supports_asconf = 1;
1827 /* one we don't care about */
1831 } else if (ptype == SCTP_RANDOM) {
1832 /* enforce the random length */
1833 if (plen != (sizeof(struct sctp_auth_random) +
1834 SCTP_AUTH_RANDOM_SIZE_REQUIRED)) {
1835 SCTPDBG(SCTP_DEBUG_AUTH1,
1836 "SCTP: invalid RANDOM len\n");
1840 } else if (ptype == SCTP_HMAC_LIST) {
1841 struct sctp_auth_hmac_algo *hmacs;
1842 uint8_t store[SCTP_PARAM_BUFFER_SIZE];
1845 if (plen > sizeof(store)) {
1848 phdr = sctp_get_next_param(m, offset,
1849 (struct sctp_paramhdr *)store,
1854 hmacs = (struct sctp_auth_hmac_algo *)phdr;
1855 num_hmacs = (plen - sizeof(*hmacs)) / sizeof(hmacs->hmac_ids[0]);
1856 /* validate the hmac list */
1857 if (sctp_verify_hmac_param(hmacs, num_hmacs)) {
1858 SCTPDBG(SCTP_DEBUG_AUTH1,
1859 "SCTP: invalid HMAC param\n");
1863 } else if (ptype == SCTP_CHUNK_LIST) {
1864 struct sctp_auth_chunk_list *chunks;
1865 uint8_t chunks_store[SCTP_SMALL_CHUNK_STORE];
1868 if (plen > sizeof(chunks_store)) {
1871 phdr = sctp_get_next_param(m, offset,
1872 (struct sctp_paramhdr *)chunks_store,
1878 * Flip through the list and mark that the
1879 * peer supports asconf/asconf_ack.
1881 chunks = (struct sctp_auth_chunk_list *)phdr;
1882 num_chunks = plen - sizeof(*chunks);
1883 for (i = 0; i < num_chunks; i++) {
1884 /* record asconf/asconf-ack if listed */
1885 if (chunks->chunk_types[i] == SCTP_ASCONF)
1887 if (chunks->chunk_types[i] == SCTP_ASCONF_ACK)
1895 offset += SCTP_SIZE32(plen);
1896 if (offset >= limit) {
1899 phdr = sctp_get_next_param(m, offset, ¶m_buf,
1902 /* validate authentication required parameters */
1903 if (got_random && got_hmacs) {
1904 peer_supports_auth = 1;
1906 peer_supports_auth = 0;
1908 if (!peer_supports_auth && got_chklist) {
1909 SCTPDBG(SCTP_DEBUG_AUTH1,
1910 "SCTP: peer sent chunk list w/o AUTH\n");
1913 if (peer_supports_asconf && !peer_supports_auth) {
1914 SCTPDBG(SCTP_DEBUG_AUTH1,
1915 "SCTP: peer supports ASCONF but not AUTH\n");
1917 } else if ((peer_supports_asconf) && (peer_supports_auth) &&
1918 ((saw_asconf == 0) || (saw_asconf_ack == 0))) {
1925 sctp_initialize_auth_params(struct sctp_inpcb *inp, struct sctp_tcb *stcb)
1927 uint16_t chunks_len = 0;
1928 uint16_t hmacs_len = 0;
1929 uint16_t random_len = SCTP_AUTH_RANDOM_SIZE_DEFAULT;
1930 sctp_key_t *new_key;
1933 /* initialize hmac list from endpoint */
1934 stcb->asoc.local_hmacs = sctp_copy_hmaclist(inp->sctp_ep.local_hmacs);
1935 if (stcb->asoc.local_hmacs != NULL) {
1936 hmacs_len = stcb->asoc.local_hmacs->num_algo *
1937 sizeof(stcb->asoc.local_hmacs->hmac[0]);
1939 /* initialize auth chunks list from endpoint */
1940 stcb->asoc.local_auth_chunks =
1941 sctp_copy_chunklist(inp->sctp_ep.local_auth_chunks);
1942 if (stcb->asoc.local_auth_chunks != NULL) {
1945 for (i = 0; i < 256; i++) {
1946 if (stcb->asoc.local_auth_chunks->chunks[i])
1950 /* copy defaults from the endpoint */
1951 stcb->asoc.authinfo.active_keyid = inp->sctp_ep.default_keyid;
1953 /* copy out the shared key list (by reference) from the endpoint */
1954 (void)sctp_copy_skeylist(&inp->sctp_ep.shared_keys,
1955 &stcb->asoc.shared_keys);
1957 /* now set the concatenated key (random + chunks + hmacs) */
1958 /* key includes parameter headers */
1959 keylen = (3 * sizeof(struct sctp_paramhdr)) + random_len + chunks_len +
1961 new_key = sctp_alloc_key(keylen);
1962 if (new_key != NULL) {
1963 struct sctp_paramhdr *ph;
1966 /* generate and copy in the RANDOM */
1967 ph = (struct sctp_paramhdr *)new_key->key;
1968 ph->param_type = htons(SCTP_RANDOM);
1969 plen = sizeof(*ph) + random_len;
1970 ph->param_length = htons(plen);
1971 SCTP_READ_RANDOM(new_key->key + sizeof(*ph), random_len);
1974 /* append in the AUTH chunks */
1975 /* NOTE: currently we always have chunks to list */
1976 ph = (struct sctp_paramhdr *)(new_key->key + keylen);
1977 ph->param_type = htons(SCTP_CHUNK_LIST);
1978 plen = sizeof(*ph) + chunks_len;
1979 ph->param_length = htons(plen);
1980 keylen += sizeof(*ph);
1981 if (stcb->asoc.local_auth_chunks) {
1984 for (i = 0; i < 256; i++) {
1985 if (stcb->asoc.local_auth_chunks->chunks[i])
1986 new_key->key[keylen++] = i;
1990 /* append in the HMACs */
1991 ph = (struct sctp_paramhdr *)(new_key->key + keylen);
1992 ph->param_type = htons(SCTP_HMAC_LIST);
1993 plen = sizeof(*ph) + hmacs_len;
1994 ph->param_length = htons(plen);
1995 keylen += sizeof(*ph);
1996 (void)sctp_serialize_hmaclist(stcb->asoc.local_hmacs,
1997 new_key->key + keylen);
1999 if (stcb->asoc.authinfo.random != NULL)
2000 sctp_free_key(stcb->asoc.authinfo.random);
2001 stcb->asoc.authinfo.random = new_key;
2002 stcb->asoc.authinfo.random_len = random_len;