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