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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
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.
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.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <netinet/sctp_os.h>
37 #include <netinet/sctp.h>
38 #include <netinet/sctp_header.h>
39 #include <netinet/sctp_pcb.h>
40 #include <netinet/sctp_var.h>
41 #include <netinet/sctp_sysctl.h>
42 #include <netinet/sctputil.h>
43 #include <netinet/sctp_indata.h>
44 #include <netinet/sctp_output.h>
45 #include <netinet/sctp_auth.h>
48 #define SCTP_AUTH_DEBUG (SCTP_BASE_SYSCTL(sctp_debug_on) & SCTP_DEBUG_AUTH1)
49 #define SCTP_AUTH_DEBUG2 (SCTP_BASE_SYSCTL(sctp_debug_on) & SCTP_DEBUG_AUTH2)
50 #endif /* SCTP_DEBUG */
54 sctp_clear_chunklist(sctp_auth_chklist_t *chklist)
56 memset(chklist, 0, sizeof(*chklist));
57 /* chklist->num_chunks = 0; */
61 sctp_alloc_chunklist(void)
63 sctp_auth_chklist_t *chklist;
65 SCTP_MALLOC(chklist, sctp_auth_chklist_t *, sizeof(*chklist),
67 if (chklist == NULL) {
68 SCTPDBG(SCTP_DEBUG_AUTH1, "sctp_alloc_chunklist: failed to get memory!\n");
70 sctp_clear_chunklist(chklist);
76 sctp_free_chunklist(sctp_auth_chklist_t *list)
79 SCTP_FREE(list, SCTP_M_AUTH_CL);
83 sctp_copy_chunklist(sctp_auth_chklist_t *list)
85 sctp_auth_chklist_t *new_list;
91 new_list = sctp_alloc_chunklist();
95 memcpy(new_list, list, sizeof(*new_list));
102 * add a chunk to the required chunks list
105 sctp_auth_add_chunk(uint8_t chunk, sctp_auth_chklist_t *list)
110 /* is chunk restricted? */
111 if ((chunk == SCTP_INITIATION) ||
112 (chunk == SCTP_INITIATION_ACK) ||
113 (chunk == SCTP_SHUTDOWN_COMPLETE) ||
114 (chunk == SCTP_AUTHENTICATION)) {
117 if (list->chunks[chunk] == 0) {
118 list->chunks[chunk] = 1;
120 SCTPDBG(SCTP_DEBUG_AUTH1,
121 "SCTP: added chunk %u (0x%02x) to Auth list\n",
128 * delete a chunk from the required chunks list
131 sctp_auth_delete_chunk(uint8_t chunk, sctp_auth_chklist_t *list)
136 if (list->chunks[chunk] == 1) {
137 list->chunks[chunk] = 0;
139 SCTPDBG(SCTP_DEBUG_AUTH1,
140 "SCTP: deleted chunk %u (0x%02x) from Auth list\n",
147 sctp_auth_get_chklist_size(const sctp_auth_chklist_t *list)
152 return (list->num_chunks);
156 * return the current number and list of required chunks caller must
157 * guarantee ptr has space for up to 256 bytes
160 sctp_serialize_auth_chunks(const sctp_auth_chklist_t *list, uint8_t *ptr)
167 for (i = 0; i < 256; i++) {
168 if (list->chunks[i] != 0) {
177 sctp_pack_auth_chunks(const sctp_auth_chklist_t *list, uint8_t *ptr)
184 if (list->num_chunks <= 32) {
185 /* just list them, one byte each */
186 for (i = 0; i < 256; i++) {
187 if (list->chunks[i] != 0) {
195 /* pack into a 32 byte bitfield */
196 for (i = 0; i < 256; i++) {
197 if (list->chunks[i] != 0) {
200 ptr[index] |= (1 << offset);
209 sctp_unpack_auth_chunks(const uint8_t *ptr, uint8_t num_chunks,
210 sctp_auth_chklist_t *list)
218 if (num_chunks <= 32) {
219 /* just pull them, one byte each */
220 for (i = 0; i < num_chunks; i++) {
221 (void)sctp_auth_add_chunk(*ptr++, list);
227 /* unpack from a 32 byte bitfield */
228 for (index = 0; index < 32; index++) {
229 for (offset = 0; offset < 8; offset++) {
230 if (ptr[index] & (1 << offset)) {
231 (void)sctp_auth_add_chunk((index * 8) + offset, list);
242 * allocate structure space for a key of length keylen
245 sctp_alloc_key(uint32_t keylen)
249 SCTP_MALLOC(new_key, sctp_key_t *, sizeof(*new_key) + keylen,
251 if (new_key == NULL) {
255 new_key->keylen = keylen;
260 sctp_free_key(sctp_key_t *key)
263 SCTP_FREE(key, SCTP_M_AUTH_KY);
267 sctp_print_key(sctp_key_t *key, const char *str)
272 SCTP_PRINTF("%s: [Null key]\n", str);
275 SCTP_PRINTF("%s: len %u, ", str, key->keylen);
277 for (i = 0; i < key->keylen; i++)
278 SCTP_PRINTF("%02x", key->key[i]);
281 SCTP_PRINTF("[Null key]\n");
286 sctp_show_key(sctp_key_t *key, const char *str)
291 SCTP_PRINTF("%s: [Null key]\n", str);
294 SCTP_PRINTF("%s: len %u, ", str, key->keylen);
296 for (i = 0; i < key->keylen; i++)
297 SCTP_PRINTF("%02x", key->key[i]);
300 SCTP_PRINTF("[Null key]\n");
305 sctp_get_keylen(sctp_key_t *key)
308 return (key->keylen);
314 * generate a new random key of length 'keylen'
317 sctp_generate_random_key(uint32_t keylen)
321 new_key = sctp_alloc_key(keylen);
322 if (new_key == NULL) {
326 SCTP_READ_RANDOM(new_key->key, keylen);
327 new_key->keylen = keylen;
332 sctp_set_key(uint8_t *key, uint32_t keylen)
336 new_key = sctp_alloc_key(keylen);
337 if (new_key == NULL) {
341 memcpy(new_key->key, key, keylen);
346 * given two keys of variable size, compute which key is "larger/smaller"
347 * returns: 1 if key1 > key2
352 sctp_compare_key(sctp_key_t *key1, sctp_key_t *key2)
356 uint32_t key1len, key2len;
357 uint8_t *key_1, *key_2;
360 /* sanity/length check */
361 key1len = sctp_get_keylen(key1);
362 key2len = sctp_get_keylen(key2);
363 if ((key1len == 0) && (key2len == 0))
365 else if (key1len == 0)
367 else if (key2len == 0)
370 if (key1len < key2len) {
377 /* check for numeric equality */
378 for (i = 0; i < maxlen; i++) {
379 /* left-pad with zeros */
380 val1 = (i < (maxlen - key1len)) ? 0 : *(key_1++);
381 val2 = (i < (maxlen - key2len)) ? 0 : *(key_2++);
384 } else if (val1 < val2) {
388 /* keys are equal value, so check lengths */
389 if (key1len == key2len)
391 else if (key1len < key2len)
398 * generate the concatenated keying material based on the two keys and the
399 * shared key (if available). draft-ietf-tsvwg-auth specifies the specific
400 * order for concatenation
403 sctp_compute_hashkey(sctp_key_t *key1, sctp_key_t *key2, sctp_key_t *shared)
409 keylen = sctp_get_keylen(key1) + sctp_get_keylen(key2) +
410 sctp_get_keylen(shared);
413 /* get space for the new key */
414 new_key = sctp_alloc_key(keylen);
415 if (new_key == NULL) {
419 new_key->keylen = keylen;
420 key_ptr = new_key->key;
422 /* all keys empty/null?! */
426 /* concatenate the keys */
427 if (sctp_compare_key(key1, key2) <= 0) {
428 /* key is shared + key1 + key2 */
429 if (sctp_get_keylen(shared)) {
430 memcpy(key_ptr, shared->key, shared->keylen);
431 key_ptr += shared->keylen;
433 if (sctp_get_keylen(key1)) {
434 memcpy(key_ptr, key1->key, key1->keylen);
435 key_ptr += key1->keylen;
437 if (sctp_get_keylen(key2)) {
438 memcpy(key_ptr, key2->key, key2->keylen);
441 /* key is shared + key2 + key1 */
442 if (sctp_get_keylen(shared)) {
443 memcpy(key_ptr, shared->key, shared->keylen);
444 key_ptr += shared->keylen;
446 if (sctp_get_keylen(key2)) {
447 memcpy(key_ptr, key2->key, key2->keylen);
448 key_ptr += key2->keylen;
450 if (sctp_get_keylen(key1)) {
451 memcpy(key_ptr, key1->key, key1->keylen);
459 sctp_alloc_sharedkey(void)
461 sctp_sharedkey_t *new_key;
463 SCTP_MALLOC(new_key, sctp_sharedkey_t *, sizeof(*new_key),
465 if (new_key == NULL) {
471 new_key->refcount = 1;
472 new_key->deactivated = 0;
477 sctp_free_sharedkey(sctp_sharedkey_t *skey)
482 if (SCTP_DECREMENT_AND_CHECK_REFCOUNT(&skey->refcount)) {
483 if (skey->key != NULL)
484 sctp_free_key(skey->key);
485 SCTP_FREE(skey, SCTP_M_AUTH_KY);
490 sctp_find_sharedkey(struct sctp_keyhead *shared_keys, uint16_t key_id)
492 sctp_sharedkey_t *skey;
494 LIST_FOREACH(skey, shared_keys, next) {
495 if (skey->keyid == key_id)
502 sctp_insert_sharedkey(struct sctp_keyhead *shared_keys,
503 sctp_sharedkey_t *new_skey)
505 sctp_sharedkey_t *skey;
507 if ((shared_keys == NULL) || (new_skey == NULL))
510 /* insert into an empty list? */
511 if (LIST_EMPTY(shared_keys)) {
512 LIST_INSERT_HEAD(shared_keys, new_skey, next);
515 /* insert into the existing list, ordered by key id */
516 LIST_FOREACH(skey, shared_keys, next) {
517 if (new_skey->keyid < skey->keyid) {
518 /* insert it before here */
519 LIST_INSERT_BEFORE(skey, new_skey, next);
521 } else if (new_skey->keyid == skey->keyid) {
522 /* replace the existing key */
523 /* verify this key *can* be replaced */
524 if ((skey->deactivated) || (skey->refcount > 1)) {
525 SCTPDBG(SCTP_DEBUG_AUTH1,
526 "can't replace shared key id %u\n",
530 SCTPDBG(SCTP_DEBUG_AUTH1,
531 "replacing shared key id %u\n",
533 LIST_INSERT_BEFORE(skey, new_skey, next);
534 LIST_REMOVE(skey, next);
535 sctp_free_sharedkey(skey);
538 if (LIST_NEXT(skey, next) == NULL) {
539 /* belongs at the end of the list */
540 LIST_INSERT_AFTER(skey, new_skey, next);
544 /* shouldn't reach here */
549 sctp_auth_key_acquire(struct sctp_tcb *stcb, uint16_t key_id)
551 sctp_sharedkey_t *skey;
553 /* find the shared key */
554 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, key_id);
556 /* bump the ref count */
558 atomic_add_int(&skey->refcount, 1);
559 SCTPDBG(SCTP_DEBUG_AUTH2,
560 "%s: stcb %p key %u refcount acquire to %d\n",
561 __func__, (void *)stcb, key_id, skey->refcount);
566 sctp_auth_key_release(struct sctp_tcb *stcb, uint16_t key_id, int so_locked
567 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
572 sctp_sharedkey_t *skey;
574 /* find the shared key */
575 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, key_id);
577 /* decrement the ref count */
579 SCTPDBG(SCTP_DEBUG_AUTH2,
580 "%s: stcb %p key %u refcount release to %d\n",
581 __func__, (void *)stcb, key_id, skey->refcount);
583 /* see if a notification should be generated */
584 if ((skey->refcount <= 2) && (skey->deactivated)) {
585 /* notify ULP that key is no longer used */
586 sctp_ulp_notify(SCTP_NOTIFY_AUTH_FREE_KEY, stcb,
587 key_id, 0, so_locked);
588 SCTPDBG(SCTP_DEBUG_AUTH2,
589 "%s: stcb %p key %u no longer used, %d\n",
590 __func__, (void *)stcb, key_id, skey->refcount);
592 sctp_free_sharedkey(skey);
596 static sctp_sharedkey_t *
597 sctp_copy_sharedkey(const sctp_sharedkey_t *skey)
599 sctp_sharedkey_t *new_skey;
603 new_skey = sctp_alloc_sharedkey();
604 if (new_skey == NULL)
606 if (skey->key != NULL)
607 new_skey->key = sctp_set_key(skey->key->key, skey->key->keylen);
609 new_skey->key = NULL;
610 new_skey->keyid = skey->keyid;
615 sctp_copy_skeylist(const struct sctp_keyhead *src, struct sctp_keyhead *dest)
617 sctp_sharedkey_t *skey, *new_skey;
620 if ((src == NULL) || (dest == NULL))
622 LIST_FOREACH(skey, src, next) {
623 new_skey = sctp_copy_sharedkey(skey);
624 if (new_skey != NULL) {
625 if (sctp_insert_sharedkey(dest, new_skey)) {
626 sctp_free_sharedkey(new_skey);
637 sctp_alloc_hmaclist(uint16_t num_hmacs)
639 sctp_hmaclist_t *new_list;
642 alloc_size = sizeof(*new_list) + num_hmacs * sizeof(new_list->hmac[0]);
643 SCTP_MALLOC(new_list, sctp_hmaclist_t *, alloc_size,
645 if (new_list == NULL) {
649 new_list->max_algo = num_hmacs;
650 new_list->num_algo = 0;
655 sctp_free_hmaclist(sctp_hmaclist_t *list)
658 SCTP_FREE(list, SCTP_M_AUTH_HL);
664 sctp_auth_add_hmacid(sctp_hmaclist_t *list, uint16_t hmac_id)
670 if (list->num_algo == list->max_algo) {
671 SCTPDBG(SCTP_DEBUG_AUTH1,
672 "SCTP: HMAC id list full, ignoring add %u\n", hmac_id);
675 if ((hmac_id != SCTP_AUTH_HMAC_ID_SHA1) &&
676 (hmac_id != SCTP_AUTH_HMAC_ID_SHA256)) {
679 /* Now is it already in the list */
680 for (i = 0; i < list->num_algo; i++) {
681 if (list->hmac[i] == hmac_id) {
682 /* already in list */
686 SCTPDBG(SCTP_DEBUG_AUTH1, "SCTP: add HMAC id %u to list\n", hmac_id);
687 list->hmac[list->num_algo++] = hmac_id;
692 sctp_copy_hmaclist(sctp_hmaclist_t *list)
694 sctp_hmaclist_t *new_list;
700 new_list = sctp_alloc_hmaclist(list->max_algo);
701 if (new_list == NULL)
704 new_list->max_algo = list->max_algo;
705 new_list->num_algo = list->num_algo;
706 for (i = 0; i < list->num_algo; i++)
707 new_list->hmac[i] = list->hmac[i];
712 sctp_default_supported_hmaclist(void)
714 sctp_hmaclist_t *new_list;
716 new_list = sctp_alloc_hmaclist(2);
717 if (new_list == NULL)
719 /* We prefer SHA256, so list it first */
720 (void)sctp_auth_add_hmacid(new_list, SCTP_AUTH_HMAC_ID_SHA256);
721 (void)sctp_auth_add_hmacid(new_list, SCTP_AUTH_HMAC_ID_SHA1);
726 * HMAC algos are listed in priority/preference order
727 * find the best HMAC id to use for the peer based on local support
730 sctp_negotiate_hmacid(sctp_hmaclist_t *peer, sctp_hmaclist_t *local)
734 if ((local == NULL) || (peer == NULL))
735 return (SCTP_AUTH_HMAC_ID_RSVD);
737 for (i = 0; i < peer->num_algo; i++) {
738 for (j = 0; j < local->num_algo; j++) {
739 if (peer->hmac[i] == local->hmac[j]) {
740 /* found the "best" one */
741 SCTPDBG(SCTP_DEBUG_AUTH1,
742 "SCTP: negotiated peer HMAC id %u\n",
744 return (peer->hmac[i]);
748 /* didn't find one! */
749 return (SCTP_AUTH_HMAC_ID_RSVD);
753 * serialize the HMAC algo list and return space used
754 * caller must guarantee ptr has appropriate space
757 sctp_serialize_hmaclist(sctp_hmaclist_t *list, uint8_t *ptr)
765 for (i = 0; i < list->num_algo; i++) {
766 hmac_id = htons(list->hmac[i]);
767 memcpy(ptr, &hmac_id, sizeof(hmac_id));
768 ptr += sizeof(hmac_id);
770 return (list->num_algo * sizeof(hmac_id));
774 sctp_verify_hmac_param(struct sctp_auth_hmac_algo *hmacs, uint32_t num_hmacs)
778 for (i = 0; i < num_hmacs; i++) {
779 if (ntohs(hmacs->hmac_ids[i]) == SCTP_AUTH_HMAC_ID_SHA1) {
787 sctp_alloc_authinfo(void)
789 sctp_authinfo_t *new_authinfo;
791 SCTP_MALLOC(new_authinfo, sctp_authinfo_t *, sizeof(*new_authinfo),
794 if (new_authinfo == NULL) {
798 memset(new_authinfo, 0, sizeof(*new_authinfo));
799 return (new_authinfo);
803 sctp_free_authinfo(sctp_authinfo_t *authinfo)
805 if (authinfo == NULL)
808 if (authinfo->random != NULL)
809 sctp_free_key(authinfo->random);
810 if (authinfo->peer_random != NULL)
811 sctp_free_key(authinfo->peer_random);
812 if (authinfo->assoc_key != NULL)
813 sctp_free_key(authinfo->assoc_key);
814 if (authinfo->recv_key != NULL)
815 sctp_free_key(authinfo->recv_key);
817 /* We are NOT dynamically allocating authinfo's right now... */
818 /* SCTP_FREE(authinfo, SCTP_M_AUTH_??); */
823 sctp_get_auth_chunk_len(uint16_t hmac_algo)
827 size = sizeof(struct sctp_auth_chunk) + sctp_get_hmac_digest_len(hmac_algo);
828 return (SCTP_SIZE32(size));
832 sctp_get_hmac_digest_len(uint16_t hmac_algo)
835 case SCTP_AUTH_HMAC_ID_SHA1:
836 return (SCTP_AUTH_DIGEST_LEN_SHA1);
837 case SCTP_AUTH_HMAC_ID_SHA256:
838 return (SCTP_AUTH_DIGEST_LEN_SHA256);
840 /* unknown HMAC algorithm: can't do anything */
846 sctp_get_hmac_block_len(uint16_t hmac_algo)
849 case SCTP_AUTH_HMAC_ID_SHA1:
851 case SCTP_AUTH_HMAC_ID_SHA256:
853 case SCTP_AUTH_HMAC_ID_RSVD:
855 /* unknown HMAC algorithm: can't do anything */
861 sctp_hmac_init(uint16_t hmac_algo, sctp_hash_context_t *ctx)
864 case SCTP_AUTH_HMAC_ID_SHA1:
865 SCTP_SHA1_INIT(&ctx->sha1);
867 case SCTP_AUTH_HMAC_ID_SHA256:
868 SCTP_SHA256_INIT(&ctx->sha256);
870 case SCTP_AUTH_HMAC_ID_RSVD:
872 /* unknown HMAC algorithm: can't do anything */
878 sctp_hmac_update(uint16_t hmac_algo, sctp_hash_context_t *ctx,
879 uint8_t *text, uint32_t textlen)
882 case SCTP_AUTH_HMAC_ID_SHA1:
883 SCTP_SHA1_UPDATE(&ctx->sha1, text, textlen);
885 case SCTP_AUTH_HMAC_ID_SHA256:
886 SCTP_SHA256_UPDATE(&ctx->sha256, text, textlen);
888 case SCTP_AUTH_HMAC_ID_RSVD:
890 /* unknown HMAC algorithm: can't do anything */
896 sctp_hmac_final(uint16_t hmac_algo, sctp_hash_context_t *ctx,
900 case SCTP_AUTH_HMAC_ID_SHA1:
901 SCTP_SHA1_FINAL(digest, &ctx->sha1);
903 case SCTP_AUTH_HMAC_ID_SHA256:
904 SCTP_SHA256_FINAL(digest, &ctx->sha256);
906 case SCTP_AUTH_HMAC_ID_RSVD:
908 /* unknown HMAC algorithm: can't do anything */
914 * Keyed-Hashing for Message Authentication: FIPS 198 (RFC 2104)
916 * Compute the HMAC digest using the desired hash key, text, and HMAC
917 * algorithm. Resulting digest is placed in 'digest' and digest length
918 * is returned, if the HMAC was performed.
920 * WARNING: it is up to the caller to supply sufficient space to hold the
924 sctp_hmac(uint16_t hmac_algo, uint8_t *key, uint32_t keylen,
925 uint8_t *text, uint32_t textlen, uint8_t *digest)
929 sctp_hash_context_t ctx;
930 uint8_t ipad[128], opad[128]; /* keyed hash inner/outer pads */
931 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
934 /* sanity check the material and length */
935 if ((key == NULL) || (keylen == 0) || (text == NULL) ||
936 (textlen == 0) || (digest == NULL)) {
937 /* can't do HMAC with empty key or text or digest store */
940 /* validate the hmac algo and get the digest length */
941 digestlen = sctp_get_hmac_digest_len(hmac_algo);
945 /* hash the key if it is longer than the hash block size */
946 blocklen = sctp_get_hmac_block_len(hmac_algo);
947 if (keylen > blocklen) {
948 sctp_hmac_init(hmac_algo, &ctx);
949 sctp_hmac_update(hmac_algo, &ctx, key, keylen);
950 sctp_hmac_final(hmac_algo, &ctx, temp);
951 /* set the hashed key as the key */
955 /* initialize the inner/outer pads with the key and "append" zeroes */
956 memset(ipad, 0, blocklen);
957 memset(opad, 0, blocklen);
958 memcpy(ipad, key, keylen);
959 memcpy(opad, key, keylen);
961 /* XOR the key with ipad and opad values */
962 for (i = 0; i < blocklen; i++) {
967 /* perform inner hash */
968 sctp_hmac_init(hmac_algo, &ctx);
969 sctp_hmac_update(hmac_algo, &ctx, ipad, blocklen);
970 sctp_hmac_update(hmac_algo, &ctx, text, textlen);
971 sctp_hmac_final(hmac_algo, &ctx, temp);
973 /* perform outer hash */
974 sctp_hmac_init(hmac_algo, &ctx);
975 sctp_hmac_update(hmac_algo, &ctx, opad, blocklen);
976 sctp_hmac_update(hmac_algo, &ctx, temp, digestlen);
977 sctp_hmac_final(hmac_algo, &ctx, digest);
984 sctp_hmac_m(uint16_t hmac_algo, uint8_t *key, uint32_t keylen,
985 struct mbuf *m, uint32_t m_offset, uint8_t *digest, uint32_t trailer)
989 sctp_hash_context_t ctx;
990 uint8_t ipad[128], opad[128]; /* keyed hash inner/outer pads */
991 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
995 /* sanity check the material and length */
996 if ((key == NULL) || (keylen == 0) || (m == NULL) || (digest == NULL)) {
997 /* can't do HMAC with empty key or text or digest store */
1000 /* validate the hmac algo and get the digest length */
1001 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1005 /* hash the key if it is longer than the hash block size */
1006 blocklen = sctp_get_hmac_block_len(hmac_algo);
1007 if (keylen > blocklen) {
1008 sctp_hmac_init(hmac_algo, &ctx);
1009 sctp_hmac_update(hmac_algo, &ctx, key, keylen);
1010 sctp_hmac_final(hmac_algo, &ctx, temp);
1011 /* set the hashed key as the key */
1015 /* initialize the inner/outer pads with the key and "append" zeroes */
1016 memset(ipad, 0, blocklen);
1017 memset(opad, 0, blocklen);
1018 memcpy(ipad, key, keylen);
1019 memcpy(opad, key, keylen);
1021 /* XOR the key with ipad and opad values */
1022 for (i = 0; i < blocklen; i++) {
1027 /* perform inner hash */
1028 sctp_hmac_init(hmac_algo, &ctx);
1029 sctp_hmac_update(hmac_algo, &ctx, ipad, blocklen);
1030 /* find the correct starting mbuf and offset (get start of text) */
1032 while ((m_tmp != NULL) && (m_offset >= (uint32_t)SCTP_BUF_LEN(m_tmp))) {
1033 m_offset -= SCTP_BUF_LEN(m_tmp);
1034 m_tmp = SCTP_BUF_NEXT(m_tmp);
1036 /* now use the rest of the mbuf chain for the text */
1037 while (m_tmp != NULL) {
1038 if ((SCTP_BUF_NEXT(m_tmp) == NULL) && trailer) {
1039 sctp_hmac_update(hmac_algo, &ctx, mtod(m_tmp, uint8_t *)+m_offset,
1040 SCTP_BUF_LEN(m_tmp) - (trailer + m_offset));
1042 sctp_hmac_update(hmac_algo, &ctx, mtod(m_tmp, uint8_t *)+m_offset,
1043 SCTP_BUF_LEN(m_tmp) - m_offset);
1046 /* clear the offset since it's only for the first mbuf */
1048 m_tmp = SCTP_BUF_NEXT(m_tmp);
1050 sctp_hmac_final(hmac_algo, &ctx, temp);
1052 /* perform outer hash */
1053 sctp_hmac_init(hmac_algo, &ctx);
1054 sctp_hmac_update(hmac_algo, &ctx, opad, blocklen);
1055 sctp_hmac_update(hmac_algo, &ctx, temp, digestlen);
1056 sctp_hmac_final(hmac_algo, &ctx, digest);
1062 * verify the HMAC digest using the desired hash key, text, and HMAC
1064 * Returns -1 on error, 0 on success.
1067 sctp_verify_hmac(uint16_t hmac_algo, uint8_t *key, uint32_t keylen,
1068 uint8_t *text, uint32_t textlen,
1069 uint8_t *digest, uint32_t digestlen)
1072 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
1074 /* sanity check the material and length */
1075 if ((key == NULL) || (keylen == 0) ||
1076 (text == NULL) || (textlen == 0) || (digest == NULL)) {
1077 /* can't do HMAC with empty key or text or digest */
1080 len = sctp_get_hmac_digest_len(hmac_algo);
1081 if ((len == 0) || (digestlen != len))
1084 /* compute the expected hash */
1085 if (sctp_hmac(hmac_algo, key, keylen, text, textlen, temp) != len)
1088 if (memcmp(digest, temp, digestlen) != 0)
1096 * computes the requested HMAC using a key struct (which may be modified if
1097 * the keylen exceeds the HMAC block len).
1100 sctp_compute_hmac(uint16_t hmac_algo, sctp_key_t *key, uint8_t *text,
1101 uint32_t textlen, uint8_t *digest)
1105 sctp_hash_context_t ctx;
1106 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
1109 if ((key == NULL) || (text == NULL) || (textlen == 0) ||
1111 /* can't do HMAC with empty key or text or digest store */
1114 /* validate the hmac algo and get the digest length */
1115 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1119 /* hash the key if it is longer than the hash block size */
1120 blocklen = sctp_get_hmac_block_len(hmac_algo);
1121 if (key->keylen > blocklen) {
1122 sctp_hmac_init(hmac_algo, &ctx);
1123 sctp_hmac_update(hmac_algo, &ctx, key->key, key->keylen);
1124 sctp_hmac_final(hmac_algo, &ctx, temp);
1125 /* save the hashed key as the new key */
1126 key->keylen = digestlen;
1127 memcpy(key->key, temp, key->keylen);
1129 return (sctp_hmac(hmac_algo, key->key, key->keylen, text, textlen,
1135 sctp_compute_hmac_m(uint16_t hmac_algo, sctp_key_t *key, struct mbuf *m,
1136 uint32_t m_offset, uint8_t *digest)
1140 sctp_hash_context_t ctx;
1141 uint8_t temp[SCTP_AUTH_DIGEST_LEN_MAX];
1144 if ((key == NULL) || (m == NULL) || (digest == NULL)) {
1145 /* can't do HMAC with empty key or text or digest store */
1148 /* validate the hmac algo and get the digest length */
1149 digestlen = sctp_get_hmac_digest_len(hmac_algo);
1153 /* hash the key if it is longer than the hash block size */
1154 blocklen = sctp_get_hmac_block_len(hmac_algo);
1155 if (key->keylen > blocklen) {
1156 sctp_hmac_init(hmac_algo, &ctx);
1157 sctp_hmac_update(hmac_algo, &ctx, key->key, key->keylen);
1158 sctp_hmac_final(hmac_algo, &ctx, temp);
1159 /* save the hashed key as the new key */
1160 key->keylen = digestlen;
1161 memcpy(key->key, temp, key->keylen);
1163 return (sctp_hmac_m(hmac_algo, key->key, key->keylen, m, m_offset, digest, 0));
1167 sctp_auth_is_supported_hmac(sctp_hmaclist_t *list, uint16_t id)
1171 if ((list == NULL) || (id == SCTP_AUTH_HMAC_ID_RSVD))
1174 for (i = 0; i < list->num_algo; i++)
1175 if (list->hmac[i] == id)
1178 /* not in the list */
1184 * clear any cached key(s) if they match the given key id on an association.
1185 * the cached key(s) will be recomputed and re-cached at next use.
1186 * ASSUMES TCB_LOCK is already held
1189 sctp_clear_cachedkeys(struct sctp_tcb *stcb, uint16_t keyid)
1194 if (keyid == stcb->asoc.authinfo.assoc_keyid) {
1195 sctp_free_key(stcb->asoc.authinfo.assoc_key);
1196 stcb->asoc.authinfo.assoc_key = NULL;
1198 if (keyid == stcb->asoc.authinfo.recv_keyid) {
1199 sctp_free_key(stcb->asoc.authinfo.recv_key);
1200 stcb->asoc.authinfo.recv_key = NULL;
1205 * clear any cached key(s) if they match the given key id for all assocs on
1207 * ASSUMES INP_WLOCK is already held
1210 sctp_clear_cachedkeys_ep(struct sctp_inpcb *inp, uint16_t keyid)
1212 struct sctp_tcb *stcb;
1217 /* clear the cached keys on all assocs on this instance */
1218 LIST_FOREACH(stcb, &inp->sctp_asoc_list, sctp_tcblist) {
1219 SCTP_TCB_LOCK(stcb);
1220 sctp_clear_cachedkeys(stcb, keyid);
1221 SCTP_TCB_UNLOCK(stcb);
1226 * delete a shared key from an association
1227 * ASSUMES TCB_LOCK is already held
1230 sctp_delete_sharedkey(struct sctp_tcb *stcb, uint16_t keyid)
1232 sctp_sharedkey_t *skey;
1237 /* is the keyid the assoc active sending key */
1238 if (keyid == stcb->asoc.authinfo.active_keyid)
1241 /* does the key exist? */
1242 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1246 /* are there other refcount holders on the key? */
1247 if (skey->refcount > 1)
1251 LIST_REMOVE(skey, next);
1252 sctp_free_sharedkey(skey); /* frees skey->key as well */
1254 /* clear any cached keys */
1255 sctp_clear_cachedkeys(stcb, keyid);
1260 * deletes a shared key from the endpoint
1261 * ASSUMES INP_WLOCK is already held
1264 sctp_delete_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1266 sctp_sharedkey_t *skey;
1271 /* is the keyid the active sending key on the endpoint */
1272 if (keyid == inp->sctp_ep.default_keyid)
1275 /* does the key exist? */
1276 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1280 /* endpoint keys are not refcounted */
1283 LIST_REMOVE(skey, next);
1284 sctp_free_sharedkey(skey); /* frees skey->key as well */
1286 /* clear any cached keys */
1287 sctp_clear_cachedkeys_ep(inp, keyid);
1292 * set the active key on an association
1293 * ASSUMES TCB_LOCK is already held
1296 sctp_auth_setactivekey(struct sctp_tcb *stcb, uint16_t keyid)
1298 sctp_sharedkey_t *skey = NULL;
1300 /* find the key on the assoc */
1301 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1303 /* that key doesn't exist */
1306 if ((skey->deactivated) && (skey->refcount > 1)) {
1307 /* can't reactivate a deactivated key with other refcounts */
1311 /* set the (new) active key */
1312 stcb->asoc.authinfo.active_keyid = keyid;
1313 /* reset the deactivated flag */
1314 skey->deactivated = 0;
1320 * set the active key on an endpoint
1321 * ASSUMES INP_WLOCK is already held
1324 sctp_auth_setactivekey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1326 sctp_sharedkey_t *skey;
1329 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1331 /* that key doesn't exist */
1334 inp->sctp_ep.default_keyid = keyid;
1339 * deactivates a shared key from the association
1340 * ASSUMES INP_WLOCK is already held
1343 sctp_deact_sharedkey(struct sctp_tcb *stcb, uint16_t keyid)
1345 sctp_sharedkey_t *skey;
1350 /* is the keyid the assoc active sending key */
1351 if (keyid == stcb->asoc.authinfo.active_keyid)
1354 /* does the key exist? */
1355 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1359 /* are there other refcount holders on the key? */
1360 if (skey->refcount == 1) {
1361 /* no other users, send a notification for this key */
1362 sctp_ulp_notify(SCTP_NOTIFY_AUTH_FREE_KEY, stcb, keyid, 0,
1366 /* mark the key as deactivated */
1367 skey->deactivated = 1;
1373 * deactivates a shared key from the endpoint
1374 * ASSUMES INP_WLOCK is already held
1377 sctp_deact_sharedkey_ep(struct sctp_inpcb *inp, uint16_t keyid)
1379 sctp_sharedkey_t *skey;
1384 /* is the keyid the active sending key on the endpoint */
1385 if (keyid == inp->sctp_ep.default_keyid)
1388 /* does the key exist? */
1389 skey = sctp_find_sharedkey(&inp->sctp_ep.shared_keys, keyid);
1393 /* endpoint keys are not refcounted */
1396 LIST_REMOVE(skey, next);
1397 sctp_free_sharedkey(skey); /* frees skey->key as well */
1403 * get local authentication parameters from cookie (from INIT-ACK)
1406 sctp_auth_get_cookie_params(struct sctp_tcb *stcb, struct mbuf *m,
1407 uint32_t offset, uint32_t length)
1409 struct sctp_paramhdr *phdr, tmp_param;
1410 uint16_t plen, ptype;
1411 uint8_t random_store[SCTP_PARAM_BUFFER_SIZE];
1412 struct sctp_auth_random *p_random = NULL;
1413 uint16_t random_len = 0;
1414 uint8_t hmacs_store[SCTP_PARAM_BUFFER_SIZE];
1415 struct sctp_auth_hmac_algo *hmacs = NULL;
1416 uint16_t hmacs_len = 0;
1417 uint8_t chunks_store[SCTP_PARAM_BUFFER_SIZE];
1418 struct sctp_auth_chunk_list *chunks = NULL;
1419 uint16_t num_chunks = 0;
1420 sctp_key_t *new_key;
1423 /* convert to upper bound */
1426 phdr = (struct sctp_paramhdr *)sctp_m_getptr(m, offset,
1427 sizeof(struct sctp_paramhdr), (uint8_t *)&tmp_param);
1428 while (phdr != NULL) {
1429 ptype = ntohs(phdr->param_type);
1430 plen = ntohs(phdr->param_length);
1432 if ((plen == 0) || (offset + plen > length))
1435 if (ptype == SCTP_RANDOM) {
1436 if (plen > sizeof(random_store))
1438 phdr = sctp_get_next_param(m, offset,
1439 (struct sctp_paramhdr *)random_store, plen);
1442 /* save the random and length for the key */
1443 p_random = (struct sctp_auth_random *)phdr;
1444 random_len = plen - sizeof(*p_random);
1445 } else if (ptype == SCTP_HMAC_LIST) {
1449 if (plen > sizeof(hmacs_store))
1451 phdr = sctp_get_next_param(m, offset,
1452 (struct sctp_paramhdr *)hmacs_store, plen);
1455 /* save the hmacs list and num for the key */
1456 hmacs = (struct sctp_auth_hmac_algo *)phdr;
1457 hmacs_len = plen - sizeof(*hmacs);
1458 num_hmacs = hmacs_len / sizeof(hmacs->hmac_ids[0]);
1459 if (stcb->asoc.local_hmacs != NULL)
1460 sctp_free_hmaclist(stcb->asoc.local_hmacs);
1461 stcb->asoc.local_hmacs = sctp_alloc_hmaclist(num_hmacs);
1462 if (stcb->asoc.local_hmacs != NULL) {
1463 for (i = 0; i < num_hmacs; i++) {
1464 (void)sctp_auth_add_hmacid(stcb->asoc.local_hmacs,
1465 ntohs(hmacs->hmac_ids[i]));
1468 } else if (ptype == SCTP_CHUNK_LIST) {
1471 if (plen > sizeof(chunks_store))
1473 phdr = sctp_get_next_param(m, offset,
1474 (struct sctp_paramhdr *)chunks_store, plen);
1477 chunks = (struct sctp_auth_chunk_list *)phdr;
1478 num_chunks = plen - sizeof(*chunks);
1479 /* save chunks list and num for the key */
1480 if (stcb->asoc.local_auth_chunks != NULL)
1481 sctp_clear_chunklist(stcb->asoc.local_auth_chunks);
1483 stcb->asoc.local_auth_chunks = sctp_alloc_chunklist();
1484 for (i = 0; i < num_chunks; i++) {
1485 (void)sctp_auth_add_chunk(chunks->chunk_types[i],
1486 stcb->asoc.local_auth_chunks);
1489 /* get next parameter */
1490 offset += SCTP_SIZE32(plen);
1491 if (offset + sizeof(struct sctp_paramhdr) > length)
1493 phdr = (struct sctp_paramhdr *)sctp_m_getptr(m, offset, sizeof(struct sctp_paramhdr),
1494 (uint8_t *)&tmp_param);
1496 /* concatenate the full random key */
1497 keylen = sizeof(*p_random) + random_len + sizeof(*hmacs) + hmacs_len;
1498 if (chunks != NULL) {
1499 keylen += sizeof(*chunks) + num_chunks;
1501 new_key = sctp_alloc_key(keylen);
1502 if (new_key != NULL) {
1503 /* copy in the RANDOM */
1504 if (p_random != NULL) {
1505 keylen = sizeof(*p_random) + random_len;
1506 memcpy(new_key->key, p_random, keylen);
1510 /* append in the AUTH chunks */
1511 if (chunks != NULL) {
1512 memcpy(new_key->key + keylen, chunks,
1513 sizeof(*chunks) + num_chunks);
1514 keylen += sizeof(*chunks) + num_chunks;
1516 /* append in the HMACs */
1517 if (hmacs != NULL) {
1518 memcpy(new_key->key + keylen, hmacs,
1519 sizeof(*hmacs) + hmacs_len);
1522 if (stcb->asoc.authinfo.random != NULL)
1523 sctp_free_key(stcb->asoc.authinfo.random);
1524 stcb->asoc.authinfo.random = new_key;
1525 stcb->asoc.authinfo.random_len = random_len;
1526 sctp_clear_cachedkeys(stcb, stcb->asoc.authinfo.assoc_keyid);
1527 sctp_clear_cachedkeys(stcb, stcb->asoc.authinfo.recv_keyid);
1529 /* negotiate what HMAC to use for the peer */
1530 stcb->asoc.peer_hmac_id = sctp_negotiate_hmacid(stcb->asoc.peer_hmacs,
1531 stcb->asoc.local_hmacs);
1533 /* copy defaults from the endpoint */
1534 /* FIX ME: put in cookie? */
1535 stcb->asoc.authinfo.active_keyid = stcb->sctp_ep->sctp_ep.default_keyid;
1536 /* copy out the shared key list (by reference) from the endpoint */
1537 (void)sctp_copy_skeylist(&stcb->sctp_ep->sctp_ep.shared_keys,
1538 &stcb->asoc.shared_keys);
1542 * compute and fill in the HMAC digest for a packet
1545 sctp_fill_hmac_digest_m(struct mbuf *m, uint32_t auth_offset,
1546 struct sctp_auth_chunk *auth, struct sctp_tcb *stcb, uint16_t keyid)
1549 sctp_sharedkey_t *skey;
1552 if ((stcb == NULL) || (auth == NULL))
1555 /* zero the digest + chunk padding */
1556 digestlen = sctp_get_hmac_digest_len(stcb->asoc.peer_hmac_id);
1557 memset(auth->hmac, 0, SCTP_SIZE32(digestlen));
1559 /* is the desired key cached? */
1560 if ((keyid != stcb->asoc.authinfo.assoc_keyid) ||
1561 (stcb->asoc.authinfo.assoc_key == NULL)) {
1562 if (stcb->asoc.authinfo.assoc_key != NULL) {
1563 /* free the old cached key */
1564 sctp_free_key(stcb->asoc.authinfo.assoc_key);
1566 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys, keyid);
1567 /* the only way skey is NULL is if null key id 0 is used */
1572 /* compute a new assoc key and cache it */
1573 stcb->asoc.authinfo.assoc_key =
1574 sctp_compute_hashkey(stcb->asoc.authinfo.random,
1575 stcb->asoc.authinfo.peer_random, key);
1576 stcb->asoc.authinfo.assoc_keyid = keyid;
1577 SCTPDBG(SCTP_DEBUG_AUTH1, "caching key id %u\n",
1578 stcb->asoc.authinfo.assoc_keyid);
1580 if (SCTP_AUTH_DEBUG)
1581 sctp_print_key(stcb->asoc.authinfo.assoc_key,
1586 /* set in the active key id */
1587 auth->shared_key_id = htons(keyid);
1589 /* compute and fill in the digest */
1590 (void)sctp_compute_hmac_m(stcb->asoc.peer_hmac_id, stcb->asoc.authinfo.assoc_key,
1591 m, auth_offset, auth->hmac);
1596 sctp_zero_m(struct mbuf *m, uint32_t m_offset, uint32_t size)
1605 /* find the correct starting mbuf and offset (get start position) */
1607 while ((m_tmp != NULL) && (m_offset >= (uint32_t)SCTP_BUF_LEN(m_tmp))) {
1608 m_offset -= SCTP_BUF_LEN(m_tmp);
1609 m_tmp = SCTP_BUF_NEXT(m_tmp);
1611 /* now use the rest of the mbuf chain */
1612 while ((m_tmp != NULL) && (size > 0)) {
1613 data = mtod(m_tmp, uint8_t *)+m_offset;
1614 if (size > (uint32_t)(SCTP_BUF_LEN(m_tmp) - m_offset)) {
1615 memset(data, 0, SCTP_BUF_LEN(m_tmp) - m_offset);
1616 size -= SCTP_BUF_LEN(m_tmp) - m_offset;
1618 memset(data, 0, size);
1621 /* clear the offset since it's only for the first mbuf */
1623 m_tmp = SCTP_BUF_NEXT(m_tmp);
1628 * process the incoming Authentication chunk
1630 * -1 on any authentication error
1631 * 0 on authentication verification
1634 sctp_handle_auth(struct sctp_tcb *stcb, struct sctp_auth_chunk *auth,
1635 struct mbuf *m, uint32_t offset)
1638 uint16_t shared_key_id;
1640 sctp_sharedkey_t *skey;
1642 uint8_t digest[SCTP_AUTH_DIGEST_LEN_MAX];
1643 uint8_t computed_digest[SCTP_AUTH_DIGEST_LEN_MAX];
1645 /* auth is checked for NULL by caller */
1646 chunklen = ntohs(auth->ch.chunk_length);
1647 if (chunklen < sizeof(*auth)) {
1648 SCTP_STAT_INCR(sctps_recvauthfailed);
1651 SCTP_STAT_INCR(sctps_recvauth);
1653 /* get the auth params */
1654 shared_key_id = ntohs(auth->shared_key_id);
1655 hmac_id = ntohs(auth->hmac_id);
1656 SCTPDBG(SCTP_DEBUG_AUTH1,
1657 "SCTP AUTH Chunk: shared key %u, HMAC id %u\n",
1658 shared_key_id, hmac_id);
1660 /* is the indicated HMAC supported? */
1661 if (!sctp_auth_is_supported_hmac(stcb->asoc.local_hmacs, hmac_id)) {
1662 struct mbuf *op_err;
1663 struct sctp_error_auth_invalid_hmac *cause;
1665 SCTP_STAT_INCR(sctps_recvivalhmacid);
1666 SCTPDBG(SCTP_DEBUG_AUTH1,
1667 "SCTP Auth: unsupported HMAC id %u\n",
1670 * report this in an Error Chunk: Unsupported HMAC
1673 op_err = sctp_get_mbuf_for_msg(sizeof(struct sctp_error_auth_invalid_hmac),
1674 0, M_NOWAIT, 1, MT_HEADER);
1675 if (op_err != NULL) {
1676 /* pre-reserve some space */
1677 SCTP_BUF_RESV_UF(op_err, sizeof(struct sctp_chunkhdr));
1678 /* fill in the error */
1679 cause = mtod(op_err, struct sctp_error_auth_invalid_hmac *);
1680 cause->cause.code = htons(SCTP_CAUSE_UNSUPPORTED_HMACID);
1681 cause->cause.length = htons(sizeof(struct sctp_error_auth_invalid_hmac));
1682 cause->hmac_id = ntohs(hmac_id);
1683 SCTP_BUF_LEN(op_err) = sizeof(struct sctp_error_auth_invalid_hmac);
1685 sctp_queue_op_err(stcb, op_err);
1689 /* get the indicated shared key, if available */
1690 if ((stcb->asoc.authinfo.recv_key == NULL) ||
1691 (stcb->asoc.authinfo.recv_keyid != shared_key_id)) {
1692 /* find the shared key on the assoc first */
1693 skey = sctp_find_sharedkey(&stcb->asoc.shared_keys,
1695 /* if the shared key isn't found, discard the chunk */
1697 SCTP_STAT_INCR(sctps_recvivalkeyid);
1698 SCTPDBG(SCTP_DEBUG_AUTH1,
1699 "SCTP Auth: unknown key id %u\n",
1703 /* generate a notification if this is a new key id */
1704 if (stcb->asoc.authinfo.recv_keyid != shared_key_id)
1706 * sctp_ulp_notify(SCTP_NOTIFY_AUTH_NEW_KEY, stcb,
1707 * shared_key_id, (void
1708 * *)stcb->asoc.authinfo.recv_keyid);
1710 sctp_notify_authentication(stcb, SCTP_AUTH_NEW_KEY,
1711 shared_key_id, stcb->asoc.authinfo.recv_keyid,
1712 SCTP_SO_NOT_LOCKED);
1713 /* compute a new recv assoc key and cache it */
1714 if (stcb->asoc.authinfo.recv_key != NULL)
1715 sctp_free_key(stcb->asoc.authinfo.recv_key);
1716 stcb->asoc.authinfo.recv_key =
1717 sctp_compute_hashkey(stcb->asoc.authinfo.random,
1718 stcb->asoc.authinfo.peer_random, skey->key);
1719 stcb->asoc.authinfo.recv_keyid = shared_key_id;
1721 if (SCTP_AUTH_DEBUG)
1722 sctp_print_key(stcb->asoc.authinfo.recv_key, "Recv Key");
1725 /* validate the digest length */
1726 digestlen = sctp_get_hmac_digest_len(hmac_id);
1727 if (chunklen < (sizeof(*auth) + digestlen)) {
1728 /* invalid digest length */
1729 SCTP_STAT_INCR(sctps_recvauthfailed);
1730 SCTPDBG(SCTP_DEBUG_AUTH1,
1731 "SCTP Auth: chunk too short for HMAC\n");
1734 /* save a copy of the digest, zero the pseudo header, and validate */
1735 memcpy(digest, auth->hmac, digestlen);
1736 sctp_zero_m(m, offset + sizeof(*auth), SCTP_SIZE32(digestlen));
1737 (void)sctp_compute_hmac_m(hmac_id, stcb->asoc.authinfo.recv_key,
1738 m, offset, computed_digest);
1740 /* compare the computed digest with the one in the AUTH chunk */
1741 if (timingsafe_bcmp(digest, computed_digest, digestlen) != 0) {
1742 SCTP_STAT_INCR(sctps_recvauthfailed);
1743 SCTPDBG(SCTP_DEBUG_AUTH1,
1744 "SCTP Auth: HMAC digest check failed\n");
1751 * Generate NOTIFICATION
1754 sctp_notify_authentication(struct sctp_tcb *stcb, uint32_t indication,
1755 uint16_t keyid, uint16_t alt_keyid, int so_locked
1756 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
1761 struct mbuf *m_notify;
1762 struct sctp_authkey_event *auth;
1763 struct sctp_queued_to_read *control;
1765 if ((stcb == NULL) ||
1766 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_SOCKET_GONE) ||
1767 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_SOCKET_ALLGONE) ||
1768 (stcb->asoc.state & SCTP_STATE_CLOSED_SOCKET)
1770 /* If the socket is gone we are out of here */
1774 if (sctp_stcb_is_feature_off(stcb->sctp_ep, stcb, SCTP_PCB_FLAGS_AUTHEVNT))
1775 /* event not enabled */
1778 m_notify = sctp_get_mbuf_for_msg(sizeof(struct sctp_authkey_event),
1779 0, M_NOWAIT, 1, MT_HEADER);
1780 if (m_notify == NULL)
1784 SCTP_BUF_LEN(m_notify) = 0;
1785 auth = mtod(m_notify, struct sctp_authkey_event *);
1786 memset(auth, 0, sizeof(struct sctp_authkey_event));
1787 auth->auth_type = SCTP_AUTHENTICATION_EVENT;
1788 auth->auth_flags = 0;
1789 auth->auth_length = sizeof(*auth);
1790 auth->auth_keynumber = keyid;
1791 auth->auth_altkeynumber = alt_keyid;
1792 auth->auth_indication = indication;
1793 auth->auth_assoc_id = sctp_get_associd(stcb);
1795 SCTP_BUF_LEN(m_notify) = sizeof(*auth);
1796 SCTP_BUF_NEXT(m_notify) = NULL;
1798 /* append to socket */
1799 control = sctp_build_readq_entry(stcb, stcb->asoc.primary_destination,
1800 0, 0, stcb->asoc.context, 0, 0, 0, m_notify);
1801 if (control == NULL) {
1803 sctp_m_freem(m_notify);
1806 control->length = SCTP_BUF_LEN(m_notify);
1807 control->spec_flags = M_NOTIFICATION;
1808 /* not that we need this */
1809 control->tail_mbuf = m_notify;
1810 sctp_add_to_readq(stcb->sctp_ep, stcb, control,
1811 &stcb->sctp_socket->so_rcv, 1, SCTP_READ_LOCK_NOT_HELD, so_locked);
1816 * validates the AUTHentication related parameters in an INIT/INIT-ACK
1817 * Note: currently only used for INIT as INIT-ACK is handled inline
1818 * with sctp_load_addresses_from_init()
1821 sctp_validate_init_auth_params(struct mbuf *m, int offset, int limit)
1823 struct sctp_paramhdr *phdr, param_buf;
1824 uint16_t ptype, plen;
1825 int peer_supports_asconf = 0;
1826 int peer_supports_auth = 0;
1827 int got_random = 0, got_hmacs = 0, got_chklist = 0;
1828 uint8_t saw_asconf = 0;
1829 uint8_t saw_asconf_ack = 0;
1831 /* go through each of the params. */
1832 phdr = sctp_get_next_param(m, offset, ¶m_buf, sizeof(param_buf));
1834 ptype = ntohs(phdr->param_type);
1835 plen = ntohs(phdr->param_length);
1837 if (offset + plen > limit) {
1840 if (plen < sizeof(struct sctp_paramhdr)) {
1843 if (ptype == SCTP_SUPPORTED_CHUNK_EXT) {
1844 /* A supported extension chunk */
1845 struct sctp_supported_chunk_types_param *pr_supported;
1846 uint8_t local_store[SCTP_SMALL_CHUNK_STORE];
1849 if (plen > sizeof(local_store)) {
1852 phdr = sctp_get_next_param(m, offset,
1853 (struct sctp_paramhdr *)&local_store,
1858 pr_supported = (struct sctp_supported_chunk_types_param *)phdr;
1859 num_ent = plen - sizeof(struct sctp_paramhdr);
1860 for (i = 0; i < num_ent; i++) {
1861 switch (pr_supported->chunk_types[i]) {
1863 case SCTP_ASCONF_ACK:
1864 peer_supports_asconf = 1;
1867 /* one we don't care about */
1871 } else if (ptype == SCTP_RANDOM) {
1872 /* enforce the random length */
1873 if (plen != (sizeof(struct sctp_auth_random) +
1874 SCTP_AUTH_RANDOM_SIZE_REQUIRED)) {
1875 SCTPDBG(SCTP_DEBUG_AUTH1,
1876 "SCTP: invalid RANDOM len\n");
1880 } else if (ptype == SCTP_HMAC_LIST) {
1881 struct sctp_auth_hmac_algo *hmacs;
1882 uint8_t store[SCTP_PARAM_BUFFER_SIZE];
1885 if (plen > sizeof(store)) {
1888 phdr = sctp_get_next_param(m, offset,
1889 (struct sctp_paramhdr *)store,
1894 hmacs = (struct sctp_auth_hmac_algo *)phdr;
1895 num_hmacs = (plen - sizeof(*hmacs)) / sizeof(hmacs->hmac_ids[0]);
1896 /* validate the hmac list */
1897 if (sctp_verify_hmac_param(hmacs, num_hmacs)) {
1898 SCTPDBG(SCTP_DEBUG_AUTH1,
1899 "SCTP: invalid HMAC param\n");
1903 } else if (ptype == SCTP_CHUNK_LIST) {
1904 struct sctp_auth_chunk_list *chunks;
1905 uint8_t chunks_store[SCTP_SMALL_CHUNK_STORE];
1908 if (plen > sizeof(chunks_store)) {
1911 phdr = sctp_get_next_param(m, offset,
1912 (struct sctp_paramhdr *)chunks_store,
1918 * Flip through the list and mark that the
1919 * peer supports asconf/asconf_ack.
1921 chunks = (struct sctp_auth_chunk_list *)phdr;
1922 num_chunks = plen - sizeof(*chunks);
1923 for (i = 0; i < num_chunks; i++) {
1924 /* record asconf/asconf-ack if listed */
1925 if (chunks->chunk_types[i] == SCTP_ASCONF)
1927 if (chunks->chunk_types[i] == SCTP_ASCONF_ACK)
1935 offset += SCTP_SIZE32(plen);
1936 if (offset >= limit) {
1939 phdr = sctp_get_next_param(m, offset, ¶m_buf,
1942 /* validate authentication required parameters */
1943 if (got_random && got_hmacs) {
1944 peer_supports_auth = 1;
1946 peer_supports_auth = 0;
1948 if (!peer_supports_auth && got_chklist) {
1949 SCTPDBG(SCTP_DEBUG_AUTH1,
1950 "SCTP: peer sent chunk list w/o AUTH\n");
1953 if (peer_supports_asconf && !peer_supports_auth) {
1954 SCTPDBG(SCTP_DEBUG_AUTH1,
1955 "SCTP: peer supports ASCONF but not AUTH\n");
1957 } else if ((peer_supports_asconf) && (peer_supports_auth) &&
1958 ((saw_asconf == 0) || (saw_asconf_ack == 0))) {
1965 sctp_initialize_auth_params(struct sctp_inpcb *inp, struct sctp_tcb *stcb)
1967 uint16_t chunks_len = 0;
1968 uint16_t hmacs_len = 0;
1969 uint16_t random_len = SCTP_AUTH_RANDOM_SIZE_DEFAULT;
1970 sctp_key_t *new_key;
1973 /* initialize hmac list from endpoint */
1974 stcb->asoc.local_hmacs = sctp_copy_hmaclist(inp->sctp_ep.local_hmacs);
1975 if (stcb->asoc.local_hmacs != NULL) {
1976 hmacs_len = stcb->asoc.local_hmacs->num_algo *
1977 sizeof(stcb->asoc.local_hmacs->hmac[0]);
1979 /* initialize auth chunks list from endpoint */
1980 stcb->asoc.local_auth_chunks =
1981 sctp_copy_chunklist(inp->sctp_ep.local_auth_chunks);
1982 if (stcb->asoc.local_auth_chunks != NULL) {
1985 for (i = 0; i < 256; i++) {
1986 if (stcb->asoc.local_auth_chunks->chunks[i])
1990 /* copy defaults from the endpoint */
1991 stcb->asoc.authinfo.active_keyid = inp->sctp_ep.default_keyid;
1993 /* copy out the shared key list (by reference) from the endpoint */
1994 (void)sctp_copy_skeylist(&inp->sctp_ep.shared_keys,
1995 &stcb->asoc.shared_keys);
1997 /* now set the concatenated key (random + chunks + hmacs) */
1998 /* key includes parameter headers */
1999 keylen = (3 * sizeof(struct sctp_paramhdr)) + random_len + chunks_len +
2001 new_key = sctp_alloc_key(keylen);
2002 if (new_key != NULL) {
2003 struct sctp_paramhdr *ph;
2006 /* generate and copy in the RANDOM */
2007 ph = (struct sctp_paramhdr *)new_key->key;
2008 ph->param_type = htons(SCTP_RANDOM);
2009 plen = sizeof(*ph) + random_len;
2010 ph->param_length = htons(plen);
2011 SCTP_READ_RANDOM(new_key->key + sizeof(*ph), random_len);
2014 /* append in the AUTH chunks */
2015 /* NOTE: currently we always have chunks to list */
2016 ph = (struct sctp_paramhdr *)(new_key->key + keylen);
2017 ph->param_type = htons(SCTP_CHUNK_LIST);
2018 plen = sizeof(*ph) + chunks_len;
2019 ph->param_length = htons(plen);
2020 keylen += sizeof(*ph);
2021 if (stcb->asoc.local_auth_chunks) {
2024 for (i = 0; i < 256; i++) {
2025 if (stcb->asoc.local_auth_chunks->chunks[i])
2026 new_key->key[keylen++] = i;
2030 /* append in the HMACs */
2031 ph = (struct sctp_paramhdr *)(new_key->key + keylen);
2032 ph->param_type = htons(SCTP_HMAC_LIST);
2033 plen = sizeof(*ph) + hmacs_len;
2034 ph->param_length = htons(plen);
2035 keylen += sizeof(*ph);
2036 (void)sctp_serialize_hmaclist(stcb->asoc.local_hmacs,
2037 new_key->key + keylen);
2039 if (stcb->asoc.authinfo.random != NULL)
2040 sctp_free_key(stcb->asoc.authinfo.random);
2041 stcb->asoc.authinfo.random = new_key;
2042 stcb->asoc.authinfo.random_len = random_len;