lustre/obdclass/capa.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  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 #define DEBUG_SUBSYSTEM S_SEC
  44
  45 #ifdef __KERNEL__
  46 #include <linux/version.h>
  47 #include <linux/fs.h>
  48 #include <asm/unistd.h>
  49 #include <linux/slab.h>
  50 #include <linux/module.h>
  51 #include <linux/init.h>
  52
  53 #include <obd_class.h>
  54 #include <lustre_debug.h>
  55 #include <lustre/lustre_idl.h>
  56 #else
  57 #include <liblustre.h>
  58 #endif
  59
  60 #include <libcfs/list.h>
  61 #include <lustre_capa.h>
  62
  63 #define NR_CAPAHASH 32
  64 #define CAPA_HASH_SIZE 3000              /* for MDS & OSS */
  65
  66 struct kmem_cache *capa_cachep;
  67
  68 #ifdef __KERNEL__
  69 /* lock for capa hash/capa_list/fo_capa_keys */
  70 DEFINE_SPINLOCK(capa_lock);
  71
  72 struct list_head capa_list[CAPA_SITE_MAX];
  73
  74 static struct capa_hmac_alg capa_hmac_algs[] = {
  75         DEF_CAPA_HMAC_ALG("sha1", SHA1, 20, 20),
  76 };
  77 #endif
  78 /* capa count */
  79 int capa_count[CAPA_SITE_MAX] = { 0, };
  80
  81 EXPORT_SYMBOL(capa_cachep);
  82 EXPORT_SYMBOL(capa_list);
  83 EXPORT_SYMBOL(capa_lock);
  84 EXPORT_SYMBOL(capa_count);
  85
  86 struct hlist_head *init_capa_hash(void)
  87 {
  88         struct hlist_head *hash;
  89         int nr_hash, i;
  90
  91         OBD_ALLOC(hash, PAGE_CACHE_SIZE);
  92         if (!hash)
  93                 return NULL;
  94
  95         nr_hash = PAGE_CACHE_SIZE / sizeof(struct hlist_head);
  96         LASSERT(nr_hash > NR_CAPAHASH);
  97
  98         for (i = 0; i < NR_CAPAHASH; i++)
  99                 INIT_HLIST_HEAD(hash + i);
 100         return hash;
 101 }
 102 EXPORT_SYMBOL(init_capa_hash);
 103
 104 #ifdef __KERNEL__
 105 static inline int capa_on_server(struct obd_capa *ocapa)
 106 {
 107         return ocapa->c_site == CAPA_SITE_SERVER;
 108 }
 109
 110 static inline void capa_delete(struct obd_capa *ocapa)
 111 {
 112         LASSERT(capa_on_server(ocapa));
 113         hlist_del_init(&ocapa->u.tgt.c_hash);
 114         list_del_init(&ocapa->c_list);
 115         capa_count[ocapa->c_site]--;
 116         /* release the ref when alloc */
 117         capa_put(ocapa);
 118 }
 119
 120 void cleanup_capa_hash(struct hlist_head *hash)
 121 {
 122         int i;
 123         struct hlist_node *pos, *next;
 124         struct obd_capa *oc;
 125
 126         spin_lock(&capa_lock);
 127         for (i = 0; i < NR_CAPAHASH; i++) {
 128                 cfs_hlist_for_each_entry_safe(oc, pos, next, hash + i,
 129                                               u.tgt.c_hash)
 130                         capa_delete(oc);
 131         }
 132         spin_unlock(&capa_lock);
 133
 134         OBD_FREE(hash, PAGE_CACHE_SIZE);
 135 }
 136 EXPORT_SYMBOL(cleanup_capa_hash);
 137
 138 static inline int capa_hashfn(struct lu_fid *fid)
 139 {
 140         return (fid_oid(fid) ^ fid_ver(fid)) *
 141                (unsigned long)(fid_seq(fid) + 1) % NR_CAPAHASH;
 142 }
 143
 144 /* capa renewal time check is earlier than that on client, which is to prevent
 145  * client renew right after obtaining it. */
 146 static inline int capa_is_to_expire(struct obd_capa *oc)
 147 {
 148         return cfs_time_before(cfs_time_sub(oc->c_expiry,
 149                                    cfs_time_seconds(oc->c_capa.lc_timeout)*2/3),
 150                                cfs_time_current());
 151 }
 152
 153 static struct obd_capa *find_capa(struct lustre_capa *capa,
 154                                   struct hlist_head *head, int alive)
 155 {
 156         struct hlist_node *pos;
 157         struct obd_capa *ocapa;
 158         int len = alive ? offsetof(struct lustre_capa, lc_keyid):sizeof(*capa);
 159
 160         cfs_hlist_for_each_entry(ocapa, pos, head, u.tgt.c_hash) {
 161                 if (memcmp(&ocapa->c_capa, capa, len))
 162                         continue;
 163                 /* don't return one that will expire soon in this case */
 164                 if (alive && capa_is_to_expire(ocapa))
 165                         continue;
 166
 167                 LASSERT(capa_on_server(ocapa));
 168
 169                 DEBUG_CAPA(D_SEC, &ocapa->c_capa, "found");
 170                 return ocapa;
 171         }
 172
 173         return NULL;
 174 }
 175
 176 #define LRU_CAPA_DELETE_COUNT 12
 177 static inline void capa_delete_lru(struct list_head *head)
 178 {
 179         struct obd_capa *ocapa;
 180         struct list_head *node = head->next;
 181         int count = 0;
 182
 183         /* free LRU_CAPA_DELETE_COUNT unused capa from head */
 184         while (count++ < LRU_CAPA_DELETE_COUNT) {
 185                 ocapa = list_entry(node, struct obd_capa, c_list);
 186                 node = node->next;
 187                 if (atomic_read(&ocapa->c_refc))
 188                         continue;
 189
 190                 DEBUG_CAPA(D_SEC, &ocapa->c_capa, "free lru");
 191                 capa_delete(ocapa);
 192         }
 193 }
 194
 195 /* add or update */
 196 struct obd_capa *capa_add(struct hlist_head *hash, struct lustre_capa *capa)
 197 {
 198         struct hlist_head *head = hash + capa_hashfn(&capa->lc_fid);
 199         struct obd_capa *ocapa, *old = NULL;
 200         struct list_head *list = &capa_list[CAPA_SITE_SERVER];
 201
 202         ocapa = alloc_capa(CAPA_SITE_SERVER);
 203         if (IS_ERR(ocapa))
 204                 return NULL;
 205
 206         spin_lock(&capa_lock);
 207         old = find_capa(capa, head, 0);
 208         if (!old) {
 209                 ocapa->c_capa = *capa;
 210                 set_capa_expiry(ocapa);
 211                 hlist_add_head(&ocapa->u.tgt.c_hash, head);
 212                 list_add_tail(&ocapa->c_list, list);
 213                 capa_get(ocapa);
 214                 capa_count[CAPA_SITE_SERVER]++;
 215                 if (capa_count[CAPA_SITE_SERVER] > CAPA_HASH_SIZE)
 216                         capa_delete_lru(list);
 217                 spin_unlock(&capa_lock);
 218                 return ocapa;
 219         } else {
 220                 capa_get(old);
 221                 spin_unlock(&capa_lock);
 222                 capa_put(ocapa);
 223                 return old;
 224         }
 225 }
 226 EXPORT_SYMBOL(capa_add);
 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 EXPORT_SYMBOL(capa_lookup);
 244
 245 int capa_hmac(__u8 *hmac, struct lustre_capa *capa, __u8 *key)
 246 {
 247         struct crypto_hash *tfm;
 248         struct capa_hmac_alg  *alg;
 249         int keylen;
 250         struct scatterlist sl;
 251
 252         if (capa_alg(capa) != CAPA_HMAC_ALG_SHA1) {
 253                 CERROR("unknown capability hmac algorithm!\n");
 254                 return -EFAULT;
 255         }
 256
 257         alg = &capa_hmac_algs[capa_alg(capa)];
 258
 259         tfm = crypto_alloc_hash(alg->ha_name, 0, 0);
 260         if (IS_ERR(tfm)) {
 261                 CERROR("crypto_alloc_tfm failed, check whether your kernel"
 262                        "has crypto support!\n");
 263                 return PTR_ERR(tfm);
 264         }
 265         keylen = alg->ha_keylen;
 266
 267         sg_init_table(&sl, 1);
 268         sg_set_page(&sl, virt_to_page(capa),
 269                     offsetof(struct lustre_capa, lc_hmac),
 270                     (unsigned long)(capa) % PAGE_CACHE_SIZE);
 271
 272         ll_crypto_hmac(tfm, key, &keylen, &sl, sl.length, hmac);
 273         crypto_free_hash(tfm);
 274
 275         return 0;
 276 }
 277 EXPORT_SYMBOL(capa_hmac);
 278
 279 int capa_encrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen)
 280 {
 281         struct crypto_blkcipher *tfm;
 282         struct scatterlist sd;
 283         struct scatterlist ss;
 284         struct blkcipher_desc desc;
 285         unsigned int min;
 286         int rc;
 287         char alg[CRYPTO_MAX_ALG_NAME+1] = "aes";
 288         ENTRY;
 289
 290         /* passing "aes" in a variable instead of a constant string keeps gcc
 291          * 4.3.2 happy */
 292         tfm = crypto_alloc_blkcipher(alg, 0, 0 );
 293         if (IS_ERR(tfm)) {
 294                 CERROR("failed to load transform for aes\n");
 295                 RETURN(PTR_ERR(tfm));
 296         }
 297
 298         min = ll_crypto_tfm_alg_min_keysize(tfm);
 299         if (keylen < min) {
 300                 CERROR("keylen at least %d bits for aes\n", min * 8);
 301                 GOTO(out, rc = -EINVAL);
 302         }
 303
 304         rc = crypto_blkcipher_setkey(tfm, key, min);
 305         if (rc) {
 306                 CERROR("failed to setting key for aes\n");
 307                 GOTO(out, rc);
 308         }
 309
 310         sg_init_table(&sd, 1);
 311         sg_set_page(&sd, virt_to_page(d), 16,
 312                     (unsigned long)(d) % PAGE_CACHE_SIZE);
 313
 314         sg_init_table(&ss, 1);
 315         sg_set_page(&ss, virt_to_page(s), 16,
 316                     (unsigned long)(s) % PAGE_CACHE_SIZE);
 317         desc.tfm   = tfm;
 318         desc.info  = NULL;
 319         desc.flags = 0;
 320         rc = crypto_blkcipher_encrypt(&desc, &sd, &ss, 16);
 321         if (rc) {
 322                 CERROR("failed to encrypt for aes\n");
 323                 GOTO(out, rc);
 324         }
 325
 326         EXIT;
 327
 328 out:
 329         crypto_free_blkcipher(tfm);
 330         return rc;
 331 }
 332 EXPORT_SYMBOL(capa_encrypt_id);
 333
 334 int capa_decrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen)
 335 {
 336         struct crypto_blkcipher *tfm;
 337         struct scatterlist sd;
 338         struct scatterlist ss;
 339         struct blkcipher_desc desc;
 340         unsigned int min;
 341         int rc;
 342         char alg[CRYPTO_MAX_ALG_NAME+1] = "aes";
 343         ENTRY;
 344
 345         /* passing "aes" in a variable instead of a constant string keeps gcc
 346          * 4.3.2 happy */
 347         tfm = crypto_alloc_blkcipher(alg, 0, 0 );
 348         if (IS_ERR(tfm)) {
 349                 CERROR("failed to load transform for aes\n");
 350                 RETURN(PTR_ERR(tfm));
 351         }
 352
 353         min = ll_crypto_tfm_alg_min_keysize(tfm);
 354         if (keylen < min) {
 355                 CERROR("keylen at least %d bits for aes\n", min * 8);
 356                 GOTO(out, rc = -EINVAL);
 357         }
 358
 359         rc = crypto_blkcipher_setkey(tfm, key, min);
 360         if (rc) {
 361                 CERROR("failed to setting key for aes\n");
 362                 GOTO(out, rc);
 363         }
 364
 365         sg_init_table(&sd, 1);
 366         sg_set_page(&sd, virt_to_page(d), 16,
 367                     (unsigned long)(d) % PAGE_CACHE_SIZE);
 368
 369         sg_init_table(&ss, 1);
 370         sg_set_page(&ss, virt_to_page(s), 16,
 371                     (unsigned long)(s) % PAGE_CACHE_SIZE);
 372
 373         desc.tfm   = tfm;
 374         desc.info  = NULL;
 375         desc.flags = 0;
 376         rc = crypto_blkcipher_decrypt(&desc, &sd, &ss, 16);
 377         if (rc) {
 378                 CERROR("failed to decrypt for aes\n");
 379                 GOTO(out, rc);
 380         }
 381
 382         EXIT;
 383
 384 out:
 385         crypto_free_blkcipher(tfm);
 386         return rc;
 387 }
 388 EXPORT_SYMBOL(capa_decrypt_id);
 389 #endif
 390
 391 void capa_cpy(void *capa, struct obd_capa *ocapa)
 392 {
 393         spin_lock(&ocapa->c_lock);
 394         *(struct lustre_capa *)capa = ocapa->c_capa;
 395         spin_unlock(&ocapa->c_lock);
 396 }
 397 EXPORT_SYMBOL(capa_cpy);
 398
 399 void _debug_capa(struct lustre_capa *c,
 400                  struct libcfs_debug_msg_data *msgdata,
 401                  const char *fmt, ... )
 402 {
 403         va_list args;
 404         va_start(args, fmt);
 405         libcfs_debug_vmsg2(msgdata, fmt, args,
 406                            " capability@%p fid "DFID" opc "LPX64" uid "LPU64
 407                            " gid "LPU64" flags %u alg %d keyid %u timeout %u "
 408                            "expiry %u\n", c, PFID(capa_fid(c)), capa_opc(c),
 409                            capa_uid(c), capa_gid(c), capa_flags(c),
 410                            capa_alg(c), capa_keyid(c), capa_timeout(c),
 411                            capa_expiry(c));
 412         va_end(args);
 413 }
 414 EXPORT_SYMBOL(_debug_capa);
 415
 416 /*
 417  * context key constructor/destructor:
 418  * lu_capainfo_key_init, lu_capainfo_key_fini
 419  */
 420 LU_KEY_INIT_FINI(lu_capainfo, struct lu_capainfo);
 421
 422 struct lu_context_key lu_capainfo_key = {
 423         .lct_tags = LCT_SERVER_SESSION,
 424         .lct_init = lu_capainfo_key_init,
 425         .lct_fini = lu_capainfo_key_fini
 426 };
 427
 428 struct lu_capainfo *lu_capainfo_get(const struct lu_env *env)
 429 {
 430         /* NB, in mdt_init0 */
 431         if (env->le_ses == NULL)
 432                 return NULL;
 433         return lu_context_key_get(env->le_ses, &lu_capainfo_key);
 434 }
 435 EXPORT_SYMBOL(lu_capainfo_get);
 436
 437 /**
 438  * Initialization of lu_capainfo_key data.
 439  */
 440 int lu_capainfo_init(void)
 441 {
 442         int rc;
 443
 444         LU_CONTEXT_KEY_INIT(&lu_capainfo_key);
 445         rc = lu_context_key_register(&lu_capainfo_key);
 446         return rc;
 447 }
 448
 449 /**
 450  * Dual to lu_capainfo_init().
 451  */
 452 void lu_capainfo_fini(void)
 453 {
 454         lu_context_key_degister(&lu_capainfo_key);
 455 }