include/net/sctp/auth.h

   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, see
  20  * <http://www.gnu.org/licenses/>.
  21  *
  22  * Please send any bug reports or fixes you make to the
  23  * email address(es):
  24  *    lksctp developers <linux-sctp@vger.kernel.org>
  25  *
  26  * Written or modified by:
  27  *   Vlad Yasevich     <vladislav.yasevich@hp.com>
  28  */
  29
  30 #ifndef __sctp_auth_h__
  31 #define __sctp_auth_h__
  32
  33 #include <linux/list.h>
  34
  35 struct sctp_endpoint;
  36 struct sctp_association;
  37 struct sctp_authkey;
  38 struct sctp_hmacalgo;
  39 struct crypto_shash;
  40
  41 /*
  42  * Define a generic struct that will hold all the info
  43  * necessary for an HMAC transform
  44  */
  45 struct sctp_hmac {
  46         __u16 hmac_id;          /* one of the above ids */
  47         char *hmac_name;        /* name for loading */
  48         __u16 hmac_len;         /* length of the signature */
  49 };
  50
  51 /* This is generic structure that containst authentication bytes used
  52  * as keying material.  It's a what is referred to as byte-vector all
  53  * over SCTP-AUTH
  54  */
  55 struct sctp_auth_bytes {
  56         atomic_t refcnt;
  57         __u32 len;
  58         __u8  data[];
  59 };
  60
  61 /* Definition for a shared key, weather endpoint or association */
  62 struct sctp_shared_key {
  63         struct list_head key_list;
  64         __u16 key_id;
  65         struct sctp_auth_bytes *key;
  66 };
  67
  68 #define key_for_each(__key, __list_head) \
  69         list_for_each_entry(__key, __list_head, key_list)
  70
  71 #define key_for_each_safe(__key, __tmp, __list_head) \
  72         list_for_each_entry_safe(__key, __tmp, __list_head, key_list)
  73
  74 static inline void sctp_auth_key_hold(struct sctp_auth_bytes *key)
  75 {
  76         if (!key)
  77                 return;
  78
  79         atomic_inc(&key->refcnt);
  80 }
  81
  82 void sctp_auth_key_put(struct sctp_auth_bytes *key);
  83 struct sctp_shared_key *sctp_auth_shkey_create(__u16 key_id, gfp_t gfp);
  84 void sctp_auth_destroy_keys(struct list_head *keys);
  85 int sctp_auth_asoc_init_active_key(struct sctp_association *asoc, gfp_t gfp);
  86 struct sctp_shared_key *sctp_auth_get_shkey(
  87                                 const struct sctp_association *asoc,
  88                                 __u16 key_id);
  89 int sctp_auth_asoc_copy_shkeys(const struct sctp_endpoint *ep,
  90                                 struct sctp_association *asoc,
  91                                 gfp_t gfp);
  92 int sctp_auth_init_hmacs(struct sctp_endpoint *ep, gfp_t gfp);
  93 void sctp_auth_destroy_hmacs(struct crypto_shash *auth_hmacs[]);
  94 struct sctp_hmac *sctp_auth_get_hmac(__u16 hmac_id);
  95 struct sctp_hmac *sctp_auth_asoc_get_hmac(const struct sctp_association *asoc);
  96 void sctp_auth_asoc_set_default_hmac(struct sctp_association *asoc,
  97                                      struct sctp_hmac_algo_param *hmacs);
  98 int sctp_auth_asoc_verify_hmac_id(const struct sctp_association *asoc,
  99                                     __be16 hmac_id);
 100 int sctp_auth_send_cid(sctp_cid_t chunk, const struct sctp_association *asoc);
 101 int sctp_auth_recv_cid(sctp_cid_t chunk, const struct sctp_association *asoc);
 102 void sctp_auth_calculate_hmac(const struct sctp_association *asoc,
 103                             struct sk_buff *skb,
 104                             struct sctp_auth_chunk *auth, gfp_t gfp);
 105
 106 /* API Helpers */
 107 int sctp_auth_ep_add_chunkid(struct sctp_endpoint *ep, __u8 chunk_id);
 108 int sctp_auth_ep_set_hmacs(struct sctp_endpoint *ep,
 109                             struct sctp_hmacalgo *hmacs);
 110 int sctp_auth_set_key(struct sctp_endpoint *ep,
 111                       struct sctp_association *asoc,
 112                       struct sctp_authkey *auth_key);
 113 int sctp_auth_set_active_key(struct sctp_endpoint *ep,
 114                       struct sctp_association *asoc,
 115                       __u16 key_id);
 116 int sctp_auth_del_key_id(struct sctp_endpoint *ep,
 117                       struct sctp_association *asoc,
 118                       __u16 key_id);
 119
 120 #endif