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