[mirror_ubuntu-bionic-kernel.git] / include / net / sctp / auth.h

/* SCTP kernel implementation
 * (C) Copyright 2007 Hewlett-Packard Development Company, L.P.
 *
 * This file is part of the SCTP kernel implementation
 *
 * This SCTP implementation is free software;
 * you can redistribute it and/or modify it under the terms of
 * the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This SCTP implementation is distributed in the hope that it
 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
 *                 ************************
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU CC; see the file COPYING.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * Please send any bug reports or fixes you make to the
 * email address(es):
 *    lksctp developers <linux-sctp@vger.kernel.org>
 *
 * Written or modified by:
 *   Vlad Yasevich     <vladislav.yasevich@hp.com>
 */

#ifndef __sctp_auth_h__
#define __sctp_auth_h__

#include <linux/list.h>
#include <linux/refcount.h>

struct sctp_endpoint;
struct sctp_association;
struct sctp_authkey;
struct sctp_hmacalgo;
struct crypto_shash;

/*
 * Define a generic struct that will hold all the info
 * necessary for an HMAC transform
 */
struct sctp_hmac {
	__u16 hmac_id;		/* one of the above ids */
	char *hmac_name;	/* name for loading */
	__u16 hmac_len;		/* length of the signature */
};

/* This is generic structure that containst authentication bytes used
 * as keying material.  It's a what is referred to as byte-vector all
 * over SCTP-AUTH
 */
struct sctp_auth_bytes {
	refcount_t refcnt;
	__u32 len;
	__u8  data[];
};

/* Definition for a shared key, weather endpoint or association */
struct sctp_shared_key {
	struct list_head key_list;
	__u16 key_id;
	struct sctp_auth_bytes *key;
};

#define key_for_each(__key, __list_head) \
	list_for_each_entry(__key, __list_head, key_list)

#define key_for_each_safe(__key, __tmp, __list_head) \
	list_for_each_entry_safe(__key, __tmp, __list_head, key_list)

static inline void sctp_auth_key_hold(struct sctp_auth_bytes *key)
{
	if (!key)
		return;

	refcount_inc(&key->refcnt);
}

void sctp_auth_key_put(struct sctp_auth_bytes *key);
struct sctp_shared_key *sctp_auth_shkey_create(__u16 key_id, gfp_t gfp);
void sctp_auth_destroy_keys(struct list_head *keys);
int sctp_auth_asoc_init_active_key(struct sctp_association *asoc, gfp_t gfp);
struct sctp_shared_key *sctp_auth_get_shkey(
				const struct sctp_association *asoc,
				__u16 key_id);
int sctp_auth_asoc_copy_shkeys(const struct sctp_endpoint *ep,
				struct sctp_association *asoc,
				gfp_t gfp);
int sctp_auth_init_hmacs(struct sctp_endpoint *ep, gfp_t gfp);
void sctp_auth_destroy_hmacs(struct crypto_shash *auth_hmacs[]);
struct sctp_hmac *sctp_auth_get_hmac(__u16 hmac_id);
struct sctp_hmac *sctp_auth_asoc_get_hmac(const struct sctp_association *asoc);
void sctp_auth_asoc_set_default_hmac(struct sctp_association *asoc,
				     struct sctp_hmac_algo_param *hmacs);
int sctp_auth_asoc_verify_hmac_id(const struct sctp_association *asoc,
				    __be16 hmac_id);
int sctp_auth_send_cid(enum sctp_cid chunk,
		       const struct sctp_association *asoc);
int sctp_auth_recv_cid(enum sctp_cid chunk,
		       const struct sctp_association *asoc);
void sctp_auth_calculate_hmac(const struct sctp_association *asoc,
			    struct sk_buff *skb,
			    struct sctp_auth_chunk *auth, gfp_t gfp);

/* API Helpers */
int sctp_auth_ep_add_chunkid(struct sctp_endpoint *ep, __u8 chunk_id);
int sctp_auth_ep_set_hmacs(struct sctp_endpoint *ep,
			    struct sctp_hmacalgo *hmacs);
int sctp_auth_set_key(struct sctp_endpoint *ep,
		      struct sctp_association *asoc,
		      struct sctp_authkey *auth_key);
int sctp_auth_set_active_key(struct sctp_endpoint *ep,
		      struct sctp_association *asoc,
		      __u16 key_id);
int sctp_auth_del_key_id(struct sctp_endpoint *ep,
		      struct sctp_association *asoc,
		      __u16 key_id);

#endif
Commit	Line	Data
60c778b2	1	/* SCTP kernel implementation
1f485649 VY	2	* (C) Copyright 2007 Hewlett-Packard Development Company, L.P.
1f485649 VY	3	*
60c778b2	4	* This file is part of the SCTP kernel implementation
1f485649	5	*
60c778b2	6	* This SCTP implementation is free software;
1f485649 VY	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	*
60c778b2	12	* This SCTP implementation is distributed in the hope that it
1f485649 VY	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
a6227e26 JK	19	* along with GNU CC; see the file COPYING. If not, see
a6227e26 JK	20	* <http://www.gnu.org/licenses/>.
1f485649 VY	21	*
	22	* Please send any bug reports or fixes you make to the
	23	* email address(es):
91705c61	24	* lksctp developers <linux-sctp@vger.kernel.org>
1f485649	25	*
1f485649 VY	26	* Written or modified by:
1f485649 VY	27	* Vlad Yasevich <vladislav.yasevich@hp.com>
1f485649 VY	28	*/
	29
	30	#ifndef __sctp_auth_h__
	31	#define __sctp_auth_h__
	32
	33	#include <linux/list.h>
6871584a	34	#include <linux/refcount.h>
1f485649 VY	35
	36	struct sctp_endpoint;
	37	struct sctp_association;
	38	struct sctp_authkey;
65b07e5d	39	struct sctp_hmacalgo;
5821c769	40	struct crypto_shash;
1f485649 VY	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 {
6871584a	57	refcount_t refcnt;
1f485649 VY	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
6871584a	80	refcount_inc(&key->refcnt);
1f485649 VY	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);
1f485649 VY	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);
5821c769	94	void sctp_auth_destroy_hmacs(struct crypto_shash *auth_hmacs[]);
1f485649 VY	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,
d06f6082	100	__be16 hmac_id);
6d85e68f XL	101	int sctp_auth_send_cid(enum sctp_cid chunk,
	102	const struct sctp_association *asoc);
	103	int sctp_auth_recv_cid(enum sctp_cid chunk,
	104	const struct sctp_association *asoc);
1f485649 VY	105	void sctp_auth_calculate_hmac(const struct sctp_association *asoc,
	106	struct sk_buff *skb,
	107	struct sctp_auth_chunk *auth, gfp_t gfp);
65b07e5d VY	108
	109	/* API Helpers */
	110	int sctp_auth_ep_add_chunkid(struct sctp_endpoint *ep, __u8 chunk_id);
	111	int sctp_auth_ep_set_hmacs(struct sctp_endpoint *ep,
	112	struct sctp_hmacalgo *hmacs);
	113	int sctp_auth_set_key(struct sctp_endpoint *ep,
	114	struct sctp_association *asoc,
	115	struct sctp_authkey *auth_key);
	116	int sctp_auth_set_active_key(struct sctp_endpoint *ep,
	117	struct sctp_association *asoc,
	118	__u16 key_id);
	119	int sctp_auth_del_key_id(struct sctp_endpoint *ep,
	120	struct sctp_association *asoc,
	121	__u16 key_id);
	122
1f485649	123	#endif