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