xref: /openbmc/linux/include/net/sctp/auth.h (revision 5bd8e16d)
1 /* SCTP kernel implementation
2  * (C) Copyright 2007 Hewlett-Packard Development Company, L.P.
3  *
4  * This file is part of the SCTP kernel implementation
5  *
6  * This SCTP implementation is free software;
7  * you can redistribute it and/or modify it under the terms of
8  * the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This SCTP implementation is distributed in the hope that it
13  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
14  *                 ************************
15  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with GNU CC; see the file COPYING.  If not, write to
20  * the Free Software Foundation, 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  *
23  * Please send any bug reports or fixes you make to the
24  * email address(es):
25  *    lksctp developers <linux-sctp@vger.kernel.org>
26  *
27  * Written or modified by:
28  *   Vlad Yasevich     <vladislav.yasevich@hp.com>
29  */
30 
31 #ifndef __sctp_auth_h__
32 #define __sctp_auth_h__
33 
34 #include <linux/list.h>
35 #include <linux/crypto.h>
36 
37 struct sctp_endpoint;
38 struct sctp_association;
39 struct sctp_authkey;
40 struct sctp_hmacalgo;
41 
42 /*
43  * Define a generic struct that will hold all the info
44  * necessary for an HMAC transform
45  */
46 struct sctp_hmac {
47 	__u16 hmac_id;		/* one of the above ids */
48 	char *hmac_name;	/* name for loading */
49 	__u16 hmac_len;		/* length of the signature */
50 };
51 
52 /* This is generic structure that containst authentication bytes used
53  * as keying material.  It's a what is referred to as byte-vector all
54  * over SCTP-AUTH
55  */
56 struct sctp_auth_bytes {
57 	atomic_t refcnt;
58 	__u32 len;
59 	__u8  data[];
60 };
61 
62 /* Definition for a shared key, weather endpoint or association */
63 struct sctp_shared_key {
64 	struct list_head key_list;
65 	__u16 key_id;
66 	struct sctp_auth_bytes *key;
67 };
68 
69 #define key_for_each(__key, __list_head) \
70 	list_for_each_entry(__key, __list_head, key_list)
71 
72 #define key_for_each_safe(__key, __tmp, __list_head) \
73 	list_for_each_entry_safe(__key, __tmp, __list_head, key_list)
74 
75 static inline void sctp_auth_key_hold(struct sctp_auth_bytes *key)
76 {
77 	if (!key)
78 		return;
79 
80 	atomic_inc(&key->refcnt);
81 }
82 
83 void sctp_auth_key_put(struct sctp_auth_bytes *key);
84 struct sctp_shared_key *sctp_auth_shkey_create(__u16 key_id, gfp_t gfp);
85 void sctp_auth_destroy_keys(struct list_head *keys);
86 int sctp_auth_asoc_init_active_key(struct sctp_association *asoc, gfp_t gfp);
87 struct sctp_shared_key *sctp_auth_get_shkey(
88 				const struct sctp_association *asoc,
89 				__u16 key_id);
90 int sctp_auth_asoc_copy_shkeys(const struct sctp_endpoint *ep,
91 				struct sctp_association *asoc,
92 				gfp_t gfp);
93 int sctp_auth_init_hmacs(struct sctp_endpoint *ep, gfp_t gfp);
94 void sctp_auth_destroy_hmacs(struct crypto_hash *auth_hmacs[]);
95 struct sctp_hmac *sctp_auth_get_hmac(__u16 hmac_id);
96 struct sctp_hmac *sctp_auth_asoc_get_hmac(const struct sctp_association *asoc);
97 void sctp_auth_asoc_set_default_hmac(struct sctp_association *asoc,
98 				     struct sctp_hmac_algo_param *hmacs);
99 int sctp_auth_asoc_verify_hmac_id(const struct sctp_association *asoc,
100 				    __be16 hmac_id);
101 int sctp_auth_send_cid(sctp_cid_t chunk, const struct sctp_association *asoc);
102 int sctp_auth_recv_cid(sctp_cid_t chunk, const struct sctp_association *asoc);
103 void sctp_auth_calculate_hmac(const struct sctp_association *asoc,
104 			    struct sk_buff *skb,
105 			    struct sctp_auth_chunk *auth, gfp_t gfp);
106 
107 /* API Helpers */
108 int sctp_auth_ep_add_chunkid(struct sctp_endpoint *ep, __u8 chunk_id);
109 int sctp_auth_ep_set_hmacs(struct sctp_endpoint *ep,
110 			    struct sctp_hmacalgo *hmacs);
111 int sctp_auth_set_key(struct sctp_endpoint *ep,
112 		      struct sctp_association *asoc,
113 		      struct sctp_authkey *auth_key);
114 int sctp_auth_set_active_key(struct sctp_endpoint *ep,
115 		      struct sctp_association *asoc,
116 		      __u16 key_id);
117 int sctp_auth_del_key_id(struct sctp_endpoint *ep,
118 		      struct sctp_association *asoc,
119 		      __u16 key_id);
120 
121 #endif
122