lustre/utils/gss/lgss_utils.h

   1 /*
   2  * Modifications for Lustre
   3  *
   4  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
   5  *
   6  * Author: Eric Mei <ericm@clusterfs.com>
   7  */
   8
   9 /*
  10   Copyright (c) 2004 The Regents of the University of Michigan.
  11   All rights reserved.
  12
  13   Redistribution and use in source and binary forms, with or without
  14   modification, are permitted provided that the following conditions
  15   are met:
  16
  17   1. Redistributions of source code must retain the above copyright
  18      notice, this list of conditions and the following disclaimer.
  19   2. Redistributions in binary form must reproduce the above copyright
  20      notice, this list of conditions and the following disclaimer in the
  21      documentation and/or other materials provided with the distribution.
  22   3. Neither the name of the University nor the names of its
  23      contributors may be used to endorse or promote products derived
  24      from this software without specific prior written permission.
  25
  26   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  27   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  28   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29   DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  33   BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  34   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  35   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  36   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37 */
  38
  39 #ifndef LGSS_UTILS_H
  40 #define LGSS_UTILS_H
  41
  42 #include <stdlib.h>
  43 #include <stdint.h>
  44 #include <gssapi/gssapi.h>
  45
  46 #define LGSS_SVC_MGS_STR        "lustre_mgs"
  47 #define LGSS_SVC_MDS_STR        "lustre_mds"
  48 #define LGSS_SVC_OSS_STR        "lustre_oss"
  49 #define LGSS_USR_ROOT_STR       "lustre_root"
  50
  51 typedef enum {
  52         LGSS_SVC_MGS    = 0,
  53         LGSS_SVC_MDS    = 1,
  54         LGSS_SVC_OSS    = 2,
  55         LGSS_SVC_MAX
  56 } lgss_svc_t;
  57
  58 extern const char *lgss_svc_str[LGSS_SVC_MAX];
  59
  60 /****************************************
  61  * inter-process locking                *
  62  ****************************************/
  63
  64 typedef enum {
  65         LGSS_MUTEX_KRB5         = 0,
  66         LGSS_MUTEX_MAX
  67 } lgss_mutex_id_t;
  68
  69 int lgss_mutex_lock(lgss_mutex_id_t mid);
  70 int lgss_mutex_unlock(lgss_mutex_id_t mid);
  71
  72 /****************************************
  73  * log facilities                       *
  74  ****************************************/
  75
  76 /*
  77  * log level:
  78  * LL_ERR:      critical error messages
  79  * LL_WARN:     warning (default)
  80  * LL_INFO:     important infomation
  81  * LL_DEBUG:    debugging
  82  * LL_TRACE:    excessive tracing messages
  83  */
  84 typedef enum {
  85         LL_ERR          = 0,
  86         LL_WARN         = 1,
  87         LL_INFO         = 2,
  88         LL_DEBUG        = 3,
  89         LL_TRACE        = 4,
  90         LL_MAX
  91 } loglevel_t;
  92
  93 extern loglevel_t g_log_level;
  94
  95 void lgss_set_loglevel(loglevel_t level);
  96
  97 void __logmsg(loglevel_t level, const char *func, const char *format, ...)
  98         __attribute__((format(printf, 3, 4)));
  99
 100 void __logmsg_gss(loglevel_t level, const char *func, const gss_OID mech,
 101                   uint32_t major, uint32_t minor, const char *format, ...)
 102         __attribute__((format(printf, 6, 7)));
 103
 104 #define logmsg(loglevel, format, args...)                               \
 105 do {                                                                    \
 106         if (loglevel <= g_log_level)                                    \
 107                 __logmsg(loglevel, __FUNCTION__, format, ##args);       \
 108 } while (0)
 109
 110 #define logmsg_gss(loglevel, mech, major, minor, format, args...)       \
 111 do {                                                                    \
 112         if (loglevel <= g_log_level)                                    \
 113                 __logmsg_gss(loglevel, __FUNCTION__, mech,              \
 114                              major, minor, format, ##args);             \
 115 } while (0)
 116
 117 #define lassert(exp)                                                    \
 118 do {                                                                    \
 119         if (!(exp)) {                                                   \
 120                 logmsg(LL_ERR, "ASSERTION FAILED: %s", #exp);           \
 121                 exit(-1);                                               \
 122         }                                                               \
 123 } while (0)
 124
 125 /*
 126  * for compatible reason, we're using files (context_xxx.c) from nfs-utils
 127  */
 128 #define printerr(priority, format, args...)                             \
 129         logmsg(priority, format, ##args)
 130
 131 #define pgsserr(msg, maj_stat, min_stat, mech)                          \
 132         logmsg_gss(LL_ERR, mech, maj_stat, min_stat, msg)
 133
 134 /****************************************
 135  * GSS MECH, OIDs                       *
 136  ****************************************/
 137
 138 extern gss_OID_desc krb5oid;
 139 extern gss_OID_desc spkm3oid;
 140
 141 typedef enum {
 142         LGSS_MECH_KRB5  = 0,
 143 } lgss_mech_t;
 144
 145 /****************************************
 146  * client credentials                   *
 147  ****************************************/
 148
 149 struct lgss_cred;
 150
 151 struct lgss_mech_type {
 152         char               *lmt_name;
 153         lgss_mech_t         lmt_mech_n;
 154
 155         int                (*lmt_init)(void);
 156         void               (*lmt_fini)(void);
 157         int                (*lmt_prepare_cred)(struct lgss_cred *cred);
 158         void               (*lmt_release_cred)(struct lgss_cred *cred);
 159         int                (*lmt_using_cred)(struct lgss_cred *cred);
 160 };
 161
 162 enum {
 163         LGSS_ROOT_CRED_ROOT     = 0x01,
 164         LGSS_ROOT_CRED_MDT      = 0x02,
 165         LGSS_ROOT_CRED_OST      = 0x04,
 166
 167         LGSS_ROOT_CRED_NR       = 3
 168 };
 169
 170 struct lgss_cred {
 171         int                     lc_uid;
 172         unsigned int            lc_root_flags;
 173         uint64_t                lc_self_nid;
 174         uint64_t                lc_tgt_nid;
 175         uint32_t                lc_tgt_svc;
 176
 177         struct lgss_mech_type  *lc_mech;
 178         void                   *lc_mech_cred;
 179 };
 180
 181 struct lgss_mech_type *lgss_name2mech(const char *mech_name);
 182 int  lgss_mech_initialize(struct lgss_mech_type *mech);
 183 void lgss_mech_finalize(struct lgss_mech_type *mech);
 184
 185 struct lgss_cred * lgss_create_cred(struct lgss_mech_type *mech);
 186 void lgss_destroy_cred(struct lgss_cred *cred);
 187 int lgss_prepare_cred(struct lgss_cred *cred);
 188 void lgss_release_cred(struct lgss_cred *cred);
 189 int lgss_using_cred(struct lgss_cred *cred);
 190
 191 int lgss_get_service_str(char **string, uint32_t lsvc, uint64_t tgt_nid);
 192
 193
 194 extern gss_OID_desc krb5oid;
 195 extern gss_OID_desc spkm3oid;
 196
 197 static inline
 198 int gss_OID_equal(gss_OID_desc *oid1, gss_OID_desc *oid2)
 199 {
 200         return (oid1->length == oid2->length &&
 201                 memcmp(oid1->elements, oid2->elements, oid1->length) == 0);
 202 }
 203
 204 #ifndef g_OID_equal
 205 #define g_OID_equal(o1,o2)      gss_OID_equal((o1), (o2))
 206 #endif
 207
 208 #endif /* LGSS_UTILS_H */