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 <inttypes.h>
  43 #include <stdlib.h>
  44 #include <stdint.h>
  45 #include <gssapi/gssapi.h>
  46
  47 #define LGSS_SVC_MGS_STR        "lustre_mgs"
  48 #define LGSS_SVC_MDS_STR        "lustre_mds"
  49 #define LGSS_SVC_OSS_STR        "lustre_oss"
  50 #define LGSS_USR_ROOT_STR       "lustre_root"
  51
  52 typedef enum {
  53         LGSS_SVC_MGS    = 0,
  54         LGSS_SVC_MDS    = 1,
  55         LGSS_SVC_OSS    = 2,
  56         LGSS_SVC_MAX
  57 } lgss_svc_t;
  58
  59 extern const char *lgss_svc_str[LGSS_SVC_MAX];
  60
  61 /****************************************
  62  * inter-process locking                *
  63  ****************************************/
  64
  65 typedef enum {
  66         LGSS_MUTEX_KRB5         = 0,
  67         LGSS_MUTEX_MAX
  68 } lgss_mutex_id_t;
  69
  70 int lgss_mutex_lock(lgss_mutex_id_t mid);
  71 int lgss_mutex_unlock(lgss_mutex_id_t mid);
  72
  73 /****************************************
  74  * log facilities                       *
  75  ****************************************/
  76
  77 /*
  78  * log level:
  79  * LL_ERR:      critical error messages
  80  * LL_WARN:     warning (default)
  81  * LL_INFO:     important infomation
  82  * LL_DEBUG:    debugging
  83  * LL_TRACE:    excessive tracing messages
  84  */
  85 typedef enum {
  86         LL_ERR          = 0,
  87         LL_WARN         = 1,
  88         LL_INFO         = 2,
  89         LL_DEBUG        = 3,
  90         LL_TRACE        = 4,
  91         LL_MAX
  92 } loglevel_t;
  93
  94 extern loglevel_t g_log_level;
  95
  96 void lgss_set_loglevel(loglevel_t level);
  97
  98 void __logmsg(loglevel_t level, const char *func, const char *format, ...)
  99         __attribute__((format(printf, 3, 4)));
 100
 101 void __logmsg_gss(loglevel_t level, const char *func, const gss_OID mech,
 102                   uint32_t major, uint32_t minor, const char *format, ...)
 103         __attribute__((format(printf, 6, 7)));
 104
 105 #define logmsg(loglevel, format, args...)                               \
 106 do {                                                                    \
 107         if (loglevel <= g_log_level)                                    \
 108                 __logmsg(loglevel, __FUNCTION__, format, ##args);       \
 109 } while (0)
 110
 111 #define logmsg_gss(loglevel, mech, major, minor, format, args...)       \
 112 do {                                                                    \
 113         if (loglevel <= g_log_level)                                    \
 114                 __logmsg_gss(loglevel, __FUNCTION__, mech,              \
 115                              major, minor, format, ##args);             \
 116 } while (0)
 117
 118 #define lassert(exp)                                                    \
 119 do {                                                                    \
 120         if (!(exp)) {                                                   \
 121                 logmsg(LL_ERR, "ASSERTION FAILED: %s", #exp);           \
 122                 exit(-1);                                               \
 123         }                                                               \
 124 } while (0)
 125
 126 /*
 127  * for compatible reason, we're using files (context_xxx.c) from nfs-utils
 128  */
 129 #define printerr(priority, format, args...)                             \
 130         logmsg(priority, format, ##args)
 131
 132 #define pgsserr(msg, maj_stat, min_stat, mech)                          \
 133         logmsg_gss(LL_ERR, mech, maj_stat, min_stat, msg)
 134
 135 /****************************************
 136  * GSS MECH, OIDs                       *
 137  ****************************************/
 138
 139 extern gss_OID_desc krb5oid;
 140 extern gss_OID_desc spkm3oid;
 141
 142 typedef enum {
 143         LGSS_MECH_KRB5  = 0,
 144 } lgss_mech_t;
 145
 146 /****************************************
 147  * client credentials                   *
 148  ****************************************/
 149
 150 struct lgss_cred;
 151
 152 struct lgss_mech_type {
 153         char               *lmt_name;
 154         lgss_mech_t         lmt_mech_n;
 155
 156         int                (*lmt_init)(void);
 157         void               (*lmt_fini)(void);
 158         int                (*lmt_prepare_cred)(struct lgss_cred *cred);
 159         void               (*lmt_release_cred)(struct lgss_cred *cred);
 160         int                (*lmt_using_cred)(struct lgss_cred *cred);
 161 };
 162
 163 enum {
 164         LGSS_ROOT_CRED_ROOT     = 0x01,
 165         LGSS_ROOT_CRED_MDT      = 0x02,
 166         LGSS_ROOT_CRED_OST      = 0x04,
 167
 168         LGSS_ROOT_CRED_NR       = 3
 169 };
 170
 171 struct lgss_cred {
 172         int                     lc_uid;
 173         unsigned int            lc_root_flags;
 174         uint64_t                lc_self_nid;
 175         uint64_t                lc_tgt_nid;
 176         uint32_t                lc_tgt_svc;
 177
 178         struct lgss_mech_type  *lc_mech;
 179         void                   *lc_mech_cred;
 180 };
 181
 182 struct lgss_mech_type *lgss_name2mech(const char *mech_name);
 183 int  lgss_mech_initialize(struct lgss_mech_type *mech);
 184 void lgss_mech_finalize(struct lgss_mech_type *mech);
 185
 186 struct lgss_cred * lgss_create_cred(struct lgss_mech_type *mech);
 187 void lgss_destroy_cred(struct lgss_cred *cred);
 188 int lgss_prepare_cred(struct lgss_cred *cred);
 189 void lgss_release_cred(struct lgss_cred *cred);
 190 int lgss_using_cred(struct lgss_cred *cred);
 191
 192 int lgss_get_service_str(char **string, uint32_t lsvc, uint64_t tgt_nid);
 193
 194
 195 extern gss_OID_desc krb5oid;
 196 extern gss_OID_desc spkm3oid;
 197
 198 static inline
 199 int gss_OID_equal(gss_OID_desc *oid1, gss_OID_desc *oid2)
 200 {
 201         return (oid1->length == oid2->length &&
 202                 memcmp(oid1->elements, oid2->elements, oid1->length) == 0);
 203 }
 204
 205 #ifndef g_OID_equal
 206 #define g_OID_equal(o1,o2)      gss_OID_equal((o1), (o2))
 207 #endif
 208
 209 #endif /* LGSS_UTILS_H */