lustre/obdclass/capa.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/obdclass/capa.c
  37  *
  38  * Lustre Capability Hash Management
  39  *
  40  * Author: Lai Siyao<lsy@clusterfs.com>
  41  */
  42
  43 #ifndef EXPORT_SYMTAB
  44 # define EXPORT_SYMTAB
  45 #endif
  46
  47 #define DEBUG_SUBSYSTEM S_SEC
  48
  49 #ifdef __KERNEL__
  50 #include <linux/version.h>
  51 #include <linux/fs.h>
  52 #include <asm/unistd.h>
  53 #include <linux/slab.h>
  54 #include <linux/module.h>
  55 #include <linux/init.h>
  56
  57 #include <obd_class.h>
  58 #include <lustre_debug.h>
  59 #include <lustre/lustre_idl.h>
  60 #else
  61 #include <liblustre.h>
  62 #endif
  63
  64 #include <libcfs/list.h>
  65 #include <lustre_capa.h>
  66
  67 #define NR_CAPAHASH 32
  68 #define CAPA_HASH_SIZE 3000              /* for MDS & OSS */
  69
  70 cfs_mem_cache_t *capa_cachep = NULL;
  71
  72 #ifdef __KERNEL__
  73 /* lock for capa hash/capa_list/fo_capa_keys */
  74 spinlock_t capa_lock = SPIN_LOCK_UNLOCKED;
  75
  76 struct list_head capa_list[CAPA_SITE_MAX];
  77
  78 static struct capa_hmac_alg capa_hmac_algs[] = {
  79         DEF_CAPA_HMAC_ALG("sha1", SHA1, 20, 20),
  80 };
  81 #endif
  82 /* capa count */
  83 int capa_count[CAPA_SITE_MAX] = { 0, };
  84
  85 EXPORT_SYMBOL(capa_cachep);
  86 EXPORT_SYMBOL(capa_list);
  87 EXPORT_SYMBOL(capa_lock);
  88 EXPORT_SYMBOL(capa_count);
  89
  90 struct hlist_head *init_capa_hash(void)
  91 {
  92         struct hlist_head *hash;
  93         int nr_hash, i;
  94
  95         OBD_ALLOC(hash, CFS_PAGE_SIZE);
  96         if (!hash)
  97                 return NULL;
  98
  99         nr_hash = CFS_PAGE_SIZE / sizeof(struct hlist_head);
 100         LASSERT(nr_hash > NR_CAPAHASH);
 101
 102         for (i = 0; i < NR_CAPAHASH; i++)
 103                 INIT_HLIST_HEAD(hash + i);
 104         return hash;
 105 }
 106
 107 #ifdef __KERNEL__
 108 static inline int capa_on_server(struct obd_capa *ocapa)
 109 {
 110         return ocapa->c_site == CAPA_SITE_SERVER;
 111 }
 112
 113 static inline void capa_delete(struct obd_capa *ocapa)
 114 {
 115         LASSERT(capa_on_server(ocapa));
 116         hlist_del_init(&ocapa->u.tgt.c_hash);
 117         list_del_init(&ocapa->c_list);
 118         capa_count[ocapa->c_site]--;
 119         /* release the ref when alloc */
 120         capa_put(ocapa);
 121 }
 122
 123 void cleanup_capa_hash(struct hlist_head *hash)
 124 {
 125         int i;
 126         struct hlist_node *pos, *next;
 127         struct obd_capa *oc;
 128
 129         spin_lock(&capa_lock);
 130         for (i = 0; i < NR_CAPAHASH; i++) {
 131                 hlist_for_each_entry_safe(oc, pos, next, hash + i, u.tgt.c_hash)
 132                         capa_delete(oc);
 133         }
 134         spin_unlock(&capa_lock);
 135
 136         OBD_FREE(hash, CFS_PAGE_SIZE);
 137 }
 138
 139 static inline int capa_hashfn(struct lu_fid *fid)
 140 {
 141         return (fid_oid(fid) ^ fid_ver(fid)) *
 142                (unsigned long)(fid_seq(fid) + 1) % NR_CAPAHASH;
 143 }
 144
 145 /* capa renewal time check is earlier than that on client, which is to prevent
 146  * client renew right after obtaining it. */
 147 static inline int capa_is_to_expire(struct obd_capa *oc)
 148 {
 149         return cfs_time_before(cfs_time_sub(oc->c_expiry,
 150                                    cfs_time_seconds(oc->c_capa.lc_timeout)*2/3),
 151                                cfs_time_current());
 152 }
 153
 154 static struct obd_capa *find_capa(struct lustre_capa *capa,
 155                                   struct hlist_head *head, int alive)
 156 {
 157         struct hlist_node *pos;
 158         struct obd_capa *ocapa;
 159         int len = alive ? offsetof(struct lustre_capa, lc_keyid):sizeof(*capa);
 160
 161         hlist_for_each_entry(ocapa, pos, head, u.tgt.c_hash) {
 162                 if (memcmp(&ocapa->c_capa, capa, len))
 163                         continue;
 164                 /* don't return one that will expire soon in this case */
 165                 if (alive && capa_is_to_expire(ocapa))
 166                         continue;
 167
 168                 LASSERT(capa_on_server(ocapa));
 169
 170                 DEBUG_CAPA(D_SEC, &ocapa->c_capa, "found");
 171                 return ocapa;
 172         }
 173
 174         return NULL;
 175 }
 176
 177 #define LRU_CAPA_DELETE_COUNT 12
 178 static inline void capa_delete_lru(struct list_head *head)
 179 {
 180         struct obd_capa *ocapa;
 181         struct list_head *node = head->next;
 182         int count = 0;
 183
 184         /* free LRU_CAPA_DELETE_COUNT unused capa from head */
 185         while (count++ < LRU_CAPA_DELETE_COUNT) {
 186                 ocapa = list_entry(node, struct obd_capa, c_list);
 187                 node = node->next;
 188                 if (atomic_read(&ocapa->c_refc))
 189                         continue;
 190
 191                 DEBUG_CAPA(D_SEC, &ocapa->c_capa, "free lru");
 192                 capa_delete(ocapa);
 193         }
 194 }
 195
 196 /* add or update */
 197 struct obd_capa *capa_add(struct hlist_head *hash, struct lustre_capa *capa)
 198 {
 199         struct hlist_head *head = hash + capa_hashfn(&capa->lc_fid);
 200         struct obd_capa *ocapa, *old = NULL;
 201         struct list_head *list = &capa_list[CAPA_SITE_SERVER];
 202
 203         ocapa = alloc_capa(CAPA_SITE_SERVER);
 204         if (IS_ERR(ocapa))
 205                 return NULL;
 206
 207         spin_lock(&capa_lock);
 208         old = find_capa(capa, head, 0);
 209         if (!old) {
 210                 ocapa->c_capa = *capa;
 211                 set_capa_expiry(ocapa);
 212                 hlist_add_head(&ocapa->u.tgt.c_hash, head);
 213                 list_add_tail(&ocapa->c_list, list);
 214                 capa_get(ocapa);
 215                 capa_count[CAPA_SITE_SERVER]++;
 216                 if (capa_count[CAPA_SITE_SERVER] > CAPA_HASH_SIZE)
 217                         capa_delete_lru(list);
 218                 spin_unlock(&capa_lock);
 219                 return ocapa;
 220         } else {
 221                 capa_get(old);
 222                 spin_unlock(&capa_lock);
 223                 capa_put(ocapa);
 224                 return old;
 225         }
 226 }
 227
 228 struct obd_capa *capa_lookup(struct hlist_head *hash, struct lustre_capa *capa,
 229                              int alive)
 230 {
 231         struct obd_capa *ocapa;
 232
 233         spin_lock(&capa_lock);
 234         ocapa = find_capa(capa, hash + capa_hashfn(&capa->lc_fid), alive);
 235         if (ocapa) {
 236                 list_move_tail(&ocapa->c_list, &capa_list[CAPA_SITE_SERVER]);
 237                 capa_get(ocapa);
 238         }
 239         spin_unlock(&capa_lock);
 240
 241         return ocapa;
 242 }
 243
 244 int capa_hmac(__u8 *hmac, struct lustre_capa *capa, __u8 *key)
 245 {
 246         struct ll_crypto_hash *tfm;
 247         struct capa_hmac_alg  *alg;
 248         int keylen;
 249         struct scatterlist sl;
 250
 251         if (capa_alg(capa) != CAPA_HMAC_ALG_SHA1) {
 252                 CERROR("unknown capability hmac algorithm!\n");
 253                 return -EFAULT;
 254         }
 255
 256         alg = &capa_hmac_algs[capa_alg(capa)];
 257
 258         tfm = ll_crypto_alloc_hash(alg->ha_name, 0, 0);
 259         if (!tfm) {
 260                 CERROR("crypto_alloc_tfm failed, check whether your kernel"
 261                        "has crypto support!\n");
 262                 return -ENOMEM;
 263         }
 264         keylen = alg->ha_keylen;
 265
 266         sg_set_page(&sl, virt_to_page(capa),
 267                     offsetof(struct lustre_capa, lc_hmac),
 268                     (unsigned long)(capa) % CFS_PAGE_SIZE);
 269
 270         ll_crypto_hmac(tfm, key, &keylen, &sl, sl.length, hmac);
 271         ll_crypto_free_hash(tfm);
 272
 273         return 0;
 274 }
 275
 276 int capa_encrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen)
 277 {
 278         struct ll_crypto_cipher *tfm;
 279         struct scatterlist sd;
 280         struct scatterlist ss;
 281         struct blkcipher_desc desc;
 282         unsigned int min;
 283         int rc;
 284         char alg[CRYPTO_MAX_ALG_NAME+1] = "aes";
 285         ENTRY;
 286
 287         /* passing "aes" in a variable instead of a constant string keeps gcc
 288          * 4.3.2 happy */
 289         tfm = ll_crypto_alloc_blkcipher(alg, 0, 0 );
 290         if (tfm == NULL) {
 291                 CERROR("failed to load transform for aes\n");
 292                 RETURN(-EFAULT);
 293         }
 294
 295         min = ll_crypto_tfm_alg_min_keysize(tfm);
 296         if (keylen < min) {
 297                 CERROR("keylen at least %d bits for aes\n", min * 8);
 298                 GOTO(out, rc = -EINVAL);
 299         }
 300
 301         rc = ll_crypto_blkcipher_setkey(tfm, key, min);
 302         if (rc) {
 303                 CERROR("failed to setting key for aes\n");
 304                 GOTO(out, rc);
 305         }
 306
 307         sg_set_page(&sd, virt_to_page(d), 16,
 308                     (unsigned long)(d) % CFS_PAGE_SIZE);
 309
 310         sg_set_page(&ss, virt_to_page(s), 16,
 311                     (unsigned long)(s) % CFS_PAGE_SIZE);
 312         desc.tfm   = tfm;
 313         desc.info  = NULL;
 314         desc.flags = 0;
 315         rc = ll_crypto_blkcipher_encrypt(&desc, &sd, &ss, 16);
 316         if (rc) {
 317                 CERROR("failed to encrypt for aes\n");
 318                 GOTO(out, rc);
 319         }
 320
 321         EXIT;
 322
 323 out:
 324         ll_crypto_free_blkcipher(tfm);
 325         return rc;
 326 }
 327
 328 int capa_decrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen)
 329 {
 330         struct ll_crypto_cipher *tfm;
 331         struct scatterlist sd;
 332         struct scatterlist ss;
 333         struct blkcipher_desc desc;
 334         unsigned int min;
 335         int rc;
 336         char alg[CRYPTO_MAX_ALG_NAME+1] = "aes";
 337         ENTRY;
 338
 339         /* passing "aes" in a variable instead of a constant string keeps gcc
 340          * 4.3.2 happy */
 341         tfm = ll_crypto_alloc_blkcipher(alg, 0, 0 );
 342         if (tfm == NULL) {
 343                 CERROR("failed to load transform for aes\n");
 344                 RETURN(-EFAULT);
 345         }
 346
 347         min = ll_crypto_tfm_alg_min_keysize(tfm);
 348         if (keylen < min) {
 349                 CERROR("keylen at least %d bits for aes\n", min * 8);
 350                 GOTO(out, rc = -EINVAL);
 351         }
 352
 353         rc = ll_crypto_blkcipher_setkey(tfm, key, min);
 354         if (rc) {
 355                 CERROR("failed to setting key for aes\n");
 356                 GOTO(out, rc);
 357         }
 358
 359         sg_set_page(&sd, virt_to_page(d), 16,
 360                     (unsigned long)(d) % CFS_PAGE_SIZE);
 361
 362         sg_set_page(&ss, virt_to_page(s), 16,
 363                     (unsigned long)(s) % CFS_PAGE_SIZE);
 364
 365         desc.tfm   = tfm;
 366         desc.info  = NULL;
 367         desc.flags = 0;
 368         rc = ll_crypto_blkcipher_decrypt(&desc, &sd, &ss, 16);
 369         if (rc) {
 370                 CERROR("failed to decrypt for aes\n");
 371                 GOTO(out, rc);
 372         }
 373
 374         EXIT;
 375
 376 out:
 377         ll_crypto_free_blkcipher(tfm);
 378         return rc;
 379 }
 380 #endif
 381
 382 void capa_cpy(void *capa, struct obd_capa *ocapa)
 383 {
 384         spin_lock(&ocapa->c_lock);
 385         *(struct lustre_capa *)capa = ocapa->c_capa;
 386         spin_unlock(&ocapa->c_lock);
 387 }
 388
 389 EXPORT_SYMBOL(init_capa_hash);
 390 EXPORT_SYMBOL(cleanup_capa_hash);
 391 EXPORT_SYMBOL(capa_add);
 392 EXPORT_SYMBOL(capa_lookup);
 393 EXPORT_SYMBOL(capa_hmac);
 394 EXPORT_SYMBOL(capa_encrypt_id);
 395 EXPORT_SYMBOL(capa_decrypt_id);
 396 EXPORT_SYMBOL(capa_cpy);