1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* SCTP kernel implementation 3 * (C) Copyright 2007 Hewlett-Packard Development Company, L.P. 4 * 5 * This file is part of the SCTP kernel implementation 6 * 7 * Please send any bug reports or fixes you make to the 8 * email address(es): 9 * lksctp developers <linux-sctp@vger.kernel.org> 10 * 11 * Written or modified by: 12 * Vlad Yasevich <vladislav.yasevich@hp.com> 13 */ 14 15 #ifndef __sctp_auth_h__ 16 #define __sctp_auth_h__ 17 18 #include <linux/list.h> 19 #include <linux/refcount.h> 20 21 struct sctp_endpoint; 22 struct sctp_association; 23 struct sctp_authkey; 24 struct sctp_hmacalgo; 25 struct sctp_cookie; 26 27 /* Defines an HMAC algorithm supported by SCTP chunk authentication */ 28 struct sctp_hmac { 29 __u16 hmac_id; /* one of SCTP_AUTH_HMAC_ID_* */ 30 __u16 hmac_len; /* length of the HMAC value in bytes */ 31 }; 32 33 /* This is generic structure that containst authentication bytes used 34 * as keying material. It's a what is referred to as byte-vector all 35 * over SCTP-AUTH 36 */ 37 struct sctp_auth_bytes { 38 refcount_t refcnt; 39 __u32 len; 40 __u8 data[]; 41 }; 42 43 /* Definition for a shared key, weather endpoint or association */ 44 struct sctp_shared_key { 45 struct list_head key_list; 46 struct sctp_auth_bytes *key; 47 refcount_t refcnt; 48 __u16 key_id; 49 __u8 deactivated; 50 }; 51 52 #define key_for_each(__key, __list_head) \ 53 list_for_each_entry(__key, __list_head, key_list) 54 55 #define key_for_each_safe(__key, __tmp, __list_head) \ 56 list_for_each_entry_safe(__key, __tmp, __list_head, key_list) 57 58 static inline void sctp_auth_key_hold(struct sctp_auth_bytes *key) 59 { 60 if (!key) 61 return; 62 63 refcount_inc(&key->refcnt); 64 } 65 66 void sctp_auth_key_put(struct sctp_auth_bytes *key); 67 struct sctp_shared_key *sctp_auth_shkey_create(__u16 key_id, gfp_t gfp); 68 void sctp_auth_destroy_keys(struct list_head *keys); 69 int sctp_auth_asoc_init_active_key(struct sctp_association *asoc, gfp_t gfp); 70 struct sctp_shared_key *sctp_auth_get_shkey( 71 const struct sctp_association *asoc, 72 __u16 key_id); 73 int sctp_auth_asoc_copy_shkeys(const struct sctp_endpoint *ep, 74 struct sctp_association *asoc, 75 gfp_t gfp); 76 bool sctp_auth_verify_cookie_params(const struct sctp_endpoint *ep, 77 const struct sctp_cookie *cookie); 78 const struct sctp_hmac *sctp_auth_get_hmac(__u16 hmac_id); 79 const struct sctp_hmac * 80 sctp_auth_asoc_get_hmac(const struct sctp_association *asoc); 81 void sctp_auth_asoc_set_default_hmac(struct sctp_association *asoc, 82 struct sctp_hmac_algo_param *hmacs); 83 int sctp_auth_asoc_verify_hmac_id(const struct sctp_association *asoc, 84 __be16 hmac_id); 85 int sctp_auth_send_cid(enum sctp_cid chunk, 86 const struct sctp_association *asoc); 87 int sctp_auth_recv_cid(enum sctp_cid chunk, 88 const struct sctp_association *asoc); 89 void sctp_auth_calculate_hmac(const struct sctp_association *asoc, 90 struct sk_buff *skb, struct sctp_auth_chunk *auth, 91 struct sctp_shared_key *ep_key, gfp_t gfp); 92 void sctp_auth_shkey_release(struct sctp_shared_key *sh_key); 93 void sctp_auth_shkey_hold(struct sctp_shared_key *sh_key); 94 95 /* API Helpers */ 96 int sctp_auth_ep_add_chunkid(struct sctp_endpoint *ep, __u8 chunk_id); 97 int sctp_auth_ep_set_hmacs(struct sctp_endpoint *ep, 98 struct sctp_hmacalgo *hmacs); 99 int sctp_auth_set_key(struct sctp_endpoint *ep, struct sctp_association *asoc, 100 struct sctp_authkey *auth_key); 101 int sctp_auth_set_active_key(struct sctp_endpoint *ep, 102 struct sctp_association *asoc, __u16 key_id); 103 int sctp_auth_del_key_id(struct sctp_endpoint *ep, 104 struct sctp_association *asoc, __u16 key_id); 105 int sctp_auth_deact_key_id(struct sctp_endpoint *ep, 106 struct sctp_association *asoc, __u16 key_id); 107 int sctp_auth_init(struct sctp_endpoint *ep, gfp_t gfp); 108 void sctp_auth_free(struct sctp_endpoint *ep); 109 110 #endif 111