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