4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/utils/gss/lgss_keyring.c
38 * user-space upcall to create GSS context, using keyring interface to kernel
40 * Author: Eric Mei <ericm@clusterfs.com>
51 #include <gssapi/gssapi.h>
53 #include <libcfs/util/string.h>
55 #include "lgss_utils.h"
56 #include "write_bytes.h"
60 * gss target string of lustre service we are negotiating for
62 static char *g_service = NULL;
65 * all data about negotiation
67 struct lgss_nego_data {
68 uint32_t lnd_established:1;
75 gss_OID lnd_mech; /* mech OID */
76 gss_name_t lnd_svc_name; /* service name */
77 u_int lnd_req_flags; /* request flags */
78 gss_cred_id_t lnd_cred; /* credential */
79 gss_ctx_id_t lnd_ctx; /* session context */
80 gss_buffer_desc lnd_rmt_ctx; /* remote handle of context */
81 uint32_t lnd_seq_win; /* sequence window */
88 * context creation response
90 struct lgss_init_res {
91 gss_buffer_desc gr_ctx; /* context handle */
92 u_int gr_major; /* major status */
93 u_int gr_minor; /* minor status */
94 u_int gr_win; /* sequence window */
95 gss_buffer_desc gr_token; /* token */
98 struct keyring_upcall_param {
109 unsigned int kup_is_root:1,
114 /****************************************
115 * child process: gss negotiation *
116 ****************************************/
118 #define INIT_CHANNEL "/proc/fs/lustre/sptlrpc/gss/init_channel"
120 int do_nego_rpc(struct lgss_nego_data *lnd,
121 gss_buffer_desc *gss_token,
122 struct lgss_init_res *gr)
124 struct lgssd_ioctl_param param;
130 logmsg(LL_TRACE, "start negotiation rpc\n");
132 pw = getpwuid(lnd->lnd_uid);
134 logmsg(LL_ERR, "no uid %u in local user database\n",
139 param.version = GSSD_INTERFACE_VERSION;
140 param.secid = lnd->lnd_secid;
141 param.uuid = lnd->lnd_uuid;
142 param.lustre_svc = lnd->lnd_lsvc;
143 param.uid = lnd->lnd_uid;
144 param.gid = pw->pw_gid;
145 param.send_token_size = gss_token->length;
146 param.send_token = (char *) gss_token->value;
147 param.reply_buf_size = sizeof(outbuf);
148 param.reply_buf = outbuf;
150 logmsg(LL_TRACE, "to open " INIT_CHANNEL "\n");
152 fd = open(INIT_CHANNEL, O_WRONLY);
154 logmsg(LL_ERR, "can't open " INIT_CHANNEL "\n");
158 logmsg(LL_TRACE, "to down-write\n");
160 ret = write(fd, ¶m, sizeof(param));
161 if (ret != sizeof(param)) {
162 logmsg(LL_ERR, "lustre ioctl err: %d\n", strerror(errno));
168 logmsg(LL_TRACE, "do_nego_rpc: to parse reply\n");
170 logmsg(LL_ERR, "status: %d (%s)\n",
171 param.status, strerror((int)param.status));
173 /* kernel return -ETIMEDOUT means the rpc timedout, we should
174 * notify the caller to reinitiate the gss negotiation, by
175 * returning -ERESTART
177 if (param.status == -ETIMEDOUT)
183 p = (unsigned int *)outbuf;
189 gr->gr_ctx.length = *p++;
190 gr->gr_ctx.value = malloc(gr->gr_ctx.length);
191 memcpy(gr->gr_ctx.value, p, gr->gr_ctx.length);
192 p += (((gr->gr_ctx.length + 3) & ~3) / 4);
194 gr->gr_token.length = *p++;
195 gr->gr_token.value = malloc(gr->gr_token.length);
196 memcpy(gr->gr_token.value, p, gr->gr_token.length);
197 p += (((gr->gr_token.length + 3) & ~3) / 4);
199 logmsg(LL_DEBUG, "do_nego_rpc: receive handle len %d, token len %d, " \
200 "res %d\n", gr->gr_ctx.length, gr->gr_token.length, res);
205 * if return error, the lnd_rpc_err or lnd_gss_err is set.
207 static int lgssc_negotiation(struct lgss_nego_data *lnd)
209 struct lgss_init_res gr;
210 gss_buffer_desc *recv_tokenp, send_token;
211 OM_uint32 maj_stat, min_stat, ret_flags;
213 logmsg(LL_TRACE, "start gss negotiation\n");
215 /* GSS context establishment loop. */
216 memset(&gr, 0, sizeof(gr));
217 recv_tokenp = GSS_C_NO_BUFFER;
220 maj_stat = gss_init_sec_context(&min_stat,
229 NULL, /* used mech */
232 NULL); /* time rec */
234 if (recv_tokenp != GSS_C_NO_BUFFER) {
235 gss_release_buffer(&min_stat, &gr.gr_token);
236 recv_tokenp = GSS_C_NO_BUFFER;
239 if (maj_stat != GSS_S_COMPLETE &&
240 maj_stat != GSS_S_CONTINUE_NEEDED) {
241 lnd->lnd_gss_err = maj_stat;
243 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
244 "failed init context");
248 if (send_token.length != 0) {
249 memset(&gr, 0, sizeof(gr));
251 lnd->lnd_rpc_err = do_nego_rpc(lnd, &send_token, &gr);
252 gss_release_buffer(&min_stat, &send_token);
254 if (lnd->lnd_rpc_err) {
255 logmsg(LL_ERR, "negotiation rpc error: %d\n",
260 if (gr.gr_major != GSS_S_COMPLETE &&
261 gr.gr_major != GSS_S_CONTINUE_NEEDED) {
262 lnd->lnd_gss_err = gr.gr_major;
264 logmsg(LL_ERR, "negotiation gss error %x\n",
269 if (gr.gr_ctx.length != 0) {
270 if (lnd->lnd_rmt_ctx.value)
271 gss_release_buffer(&min_stat,
273 lnd->lnd_rmt_ctx = gr.gr_ctx;
276 if (gr.gr_token.length != 0) {
277 if (maj_stat != GSS_S_CONTINUE_NEEDED)
279 recv_tokenp = &gr.gr_token;
283 /* GSS_S_COMPLETE => check gss header verifier,
284 * usually checked in gss_validate
286 if (maj_stat == GSS_S_COMPLETE) {
287 lnd->lnd_established = 1;
288 lnd->lnd_seq_win = gr.gr_win;
293 /* End context negotiation loop. */
294 if (!lnd->lnd_established) {
295 if (gr.gr_token.length != 0)
296 gss_release_buffer(&min_stat, &gr.gr_token);
298 if (lnd->lnd_gss_err == GSS_S_COMPLETE)
299 lnd->lnd_rpc_err = -EACCES;
301 logmsg(LL_ERR, "context negotiation failed\n");
305 logmsg(LL_DEBUG, "successfully negotiated a context\n");
310 * if return error, the lnd_rpc_err or lnd_gss_err is set.
312 static int lgssc_init_nego_data(struct lgss_nego_data *lnd,
313 struct keyring_upcall_param *kup,
316 gss_buffer_desc sname;
317 OM_uint32 maj_stat, min_stat;
319 memset(lnd, 0, sizeof(*lnd));
321 lnd->lnd_secid = kup->kup_secid;
322 lnd->lnd_uid = kup->kup_uid;
323 lnd->lnd_lsvc = kup->kup_svc;
324 lnd->lnd_uuid = kup->kup_tgt;
326 lnd->lnd_established = 0;
327 lnd->lnd_svc_name = GSS_C_NO_NAME;
328 lnd->lnd_cred = GSS_C_NO_CREDENTIAL;
329 lnd->lnd_ctx = GSS_C_NO_CONTEXT;
330 lnd->lnd_rmt_ctx = (gss_buffer_desc) GSS_C_EMPTY_BUFFER;
331 lnd->lnd_seq_win = 0;
335 lnd->lnd_mech = (gss_OID) &krb5oid;
336 lnd->lnd_req_flags = GSS_C_MUTUAL_FLAG;
339 logmsg(LL_ERR, "invalid mech: %d\n", mech);
340 lnd->lnd_rpc_err = -EACCES;
344 sname.value = g_service;
345 sname.length = strlen(g_service);
347 maj_stat = gss_import_name(&min_stat, &sname,
348 (gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
350 if (maj_stat != GSS_S_COMPLETE) {
351 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
352 "can't import svc name");
353 lnd->lnd_gss_err = maj_stat;
360 void lgssc_fini_nego_data(struct lgss_nego_data *lnd)
362 OM_uint32 maj_stat, min_stat;
364 if (lnd->lnd_svc_name != GSS_C_NO_NAME) {
365 maj_stat = gss_release_name(&min_stat, &lnd->lnd_svc_name);
366 if (maj_stat != GSS_S_COMPLETE)
367 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
368 "can't release service name");
371 if (lnd->lnd_cred != GSS_C_NO_CREDENTIAL) {
372 maj_stat = gss_release_cred(&min_stat, &lnd->lnd_cred);
373 if (maj_stat != GSS_S_COMPLETE)
374 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
375 "can't release credential");
380 int error_kernel_key(key_serial_t keyid, int rpc_error, int gss_error)
386 logmsg(LL_TRACE, "revoking kernel key %08x\n", keyid);
389 end = buf + sizeof(buf);
391 WRITE_BYTES(&p, end, seqwin);
392 WRITE_BYTES(&p, end, rpc_error);
393 WRITE_BYTES(&p, end, gss_error);
396 if (keyctl_update(keyid, buf, p - buf)) {
397 if (errno != EAGAIN) {
398 logmsg(LL_ERR, "revoke key %08x: %s\n",
399 keyid, strerror(errno));
403 logmsg(LL_WARN, "key %08x: revoking too soon, try again\n",
409 logmsg(LL_INFO, "key %08x: revoked\n", keyid);
414 int update_kernel_key(key_serial_t keyid,
415 struct lgss_nego_data *lnd,
416 gss_buffer_desc *ctx_token)
418 char *buf = NULL, *p = NULL, *end = NULL;
419 unsigned int buf_size = 0;
422 logmsg(LL_TRACE, "updating kernel key %08x\n", keyid);
424 buf_size = sizeof(lnd->lnd_seq_win) +
425 sizeof(lnd->lnd_rmt_ctx.length) + lnd->lnd_rmt_ctx.length +
426 sizeof(ctx_token->length) + ctx_token->length;
427 buf = malloc(buf_size);
429 logmsg(LL_ERR, "key %08x: can't alloc update buf: size %d\n",
435 end = buf + buf_size;
438 if (WRITE_BYTES(&p, end, lnd->lnd_seq_win))
440 if (write_buffer(&p, end, &lnd->lnd_rmt_ctx))
442 if (write_buffer(&p, end, ctx_token))
446 if (keyctl_update(keyid, buf, p - buf)) {
447 if (errno != EAGAIN) {
448 logmsg(LL_ERR, "update key %08x: %s\n",
449 keyid, strerror(errno));
453 logmsg(LL_DEBUG, "key %08x: updating too soon, try again\n",
460 logmsg(LL_DEBUG, "key %08x: updated\n", keyid);
467 * note we inherited assumed authority from parent process
469 static int lgssc_kr_negotiate(key_serial_t keyid, struct lgss_cred *cred,
470 struct keyring_upcall_param *kup)
472 struct lgss_nego_data lnd;
473 gss_buffer_desc token = GSS_C_EMPTY_BUFFER;
477 logmsg(LL_TRACE, "child start on behalf of key %08x: "
478 "cred %p, uid %u, svc %u, nid %llx, uids: %u:%u/%u:%u\n",
479 keyid, cred, cred->lc_uid, cred->lc_tgt_svc, cred->lc_tgt_nid,
480 kup->kup_uid, kup->kup_gid, kup->kup_fsuid, kup->kup_fsgid);
482 if (lgss_get_service_str(&g_service, kup->kup_svc, kup->kup_nid)) {
483 logmsg(LL_ERR, "key %08x: failed to construct service "
485 error_kernel_key(keyid, -EACCES, 0);
489 if (lgss_using_cred(cred)) {
490 logmsg(LL_ERR, "key %08x: can't using cred\n", keyid);
491 error_kernel_key(keyid, -EACCES, 0);
495 if (lgssc_init_nego_data(&lnd, kup, cred->lc_mech->lmt_mech_n)) {
496 logmsg(LL_ERR, "key %08x: failed to initialize "
497 "negotiation data\n", keyid);
498 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
502 rc = lgssc_negotiation(&lnd);
504 logmsg(LL_ERR, "key %08x: failed to negotiation\n", keyid);
505 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
509 rc = serialize_context_for_kernel(lnd.lnd_ctx, &token, lnd.lnd_mech);
511 logmsg(LL_ERR, "key %08x: failed to export context\n", keyid);
512 error_kernel_key(keyid, rc, lnd.lnd_gss_err);
516 rc = update_kernel_key(keyid, &lnd, &token);
521 logmsg(LL_INFO, "key %08x for user %u is updated OK!\n",
522 keyid, kup->kup_uid);
524 if (token.length != 0)
525 gss_release_buffer(&min_stat, &token);
527 lgssc_fini_nego_data(&lnd);
530 lgss_release_cred(cred);
535 * call out info format: s[:s]...
537 * [1]: mech_name (string)
540 * [4]: flags (string) FMT: r-root; m-mdt; o-ost
541 * [5]: lustre_svc (uint)
542 * [6]: target_nid (uint64)
543 * [7]: target_uuid (string)
545 static int parse_callout_info(const char *coinfo,
546 struct keyring_upcall_param *uparam)
555 length = strlen(coinfo) + 1;
557 logmsg(LL_ERR, "coinfo too long\n");
560 memcpy(buf, coinfo, length);
562 for (i = 0; i < nargs - 1; i++) {
563 pos = strchr(string, ':');
565 logmsg(LL_ERR, "short of components\n");
575 logmsg(LL_TRACE, "components: %s,%s,%s,%s,%s,%s,%s,%s\n",
576 data[0], data[1], data[2], data[3], data[4], data[5],
579 uparam->kup_secid = strtol(data[0], NULL, 0);
580 strlcpy(uparam->kup_mech, data[1], sizeof(uparam->kup_mech));
581 uparam->kup_uid = strtol(data[2], NULL, 0);
582 uparam->kup_gid = strtol(data[3], NULL, 0);
583 if (strchr(data[4], 'r'))
584 uparam->kup_is_root = 1;
585 if (strchr(data[4], 'm'))
586 uparam->kup_is_mdt = 1;
587 if (strchr(data[4], 'o'))
588 uparam->kup_is_ost = 1;
589 uparam->kup_svc = strtol(data[5], NULL, 0);
590 uparam->kup_nid = strtoll(data[6], NULL, 0);
591 strlcpy(uparam->kup_tgt, data[7], sizeof(uparam->kup_tgt));
593 logmsg(LL_DEBUG, "parse call out info: secid %d, mech %s, ugid %u:%u "
594 "is_root %d, is_mdt %d, is_ost %d, svc %d, nid 0x%llx, tgt %s\n",
595 uparam->kup_secid, uparam->kup_mech,
596 uparam->kup_uid, uparam->kup_gid,
597 uparam->kup_is_root, uparam->kup_is_mdt, uparam->kup_is_ost,
598 uparam->kup_svc, uparam->kup_nid, uparam->kup_tgt);
602 #define LOG_LEVEL_PATH "/proc/fs/lustre/sptlrpc/gss/lgss_keyring/debug_level"
604 static void set_log_level()
609 file = fopen(LOG_LEVEL_PATH, "r");
613 if (fscanf(file, "%u", &level) != 1)
619 lgss_set_loglevel(level);
624 /****************************************
626 ****************************************/
628 int main(int argc, char *argv[])
630 struct keyring_upcall_param uparam;
633 key_serial_t inst_keyring;
635 struct lgss_mech_type *mech;
636 struct lgss_cred *cred;
640 logmsg(LL_TRACE, "start parsing parameters\n");
642 * parse & sanity check upcall parameters
643 * expected to be called with:
647 * [4]: key description
651 * [8]: thread keyring
652 * [9]: process keyring
653 * [10]: session keyring
655 if (argc != 10 + 1) {
656 logmsg(LL_ERR, "invalid parameter number %d\n", argc);
660 logmsg(LL_INFO, "key %s, desc %s, ugid %s:%s, sring %s, coinfo %s\n",
661 argv[2], argv[4], argv[6], argv[7], argv[10], argv[5]);
663 memset(&uparam, 0, sizeof(uparam));
665 if (strcmp(argv[1], "create") != 0) {
666 logmsg(LL_ERR, "invalid OP %s\n", argv[1]);
670 if (sscanf(argv[2], "%d", &keyid) != 1) {
671 logmsg(LL_ERR, "can't extract KeyID: %s\n", argv[2]);
675 if (sscanf(argv[6], "%d", &uparam.kup_fsuid) != 1) {
676 logmsg(LL_ERR, "can't extract UID: %s\n", argv[6]);
680 if (sscanf(argv[7], "%d", &uparam.kup_fsgid) != 1) {
681 logmsg(LL_ERR, "can't extract GID: %s\n", argv[7]);
685 if (sscanf(argv[10], "%d", &sring) != 1) {
686 logmsg(LL_ERR, "can't extract session keyring: %s\n", argv[10]);
690 if (parse_callout_info(argv[5], &uparam)) {
691 logmsg(LL_ERR, "can't extract callout info: %s\n", argv[5]);
695 logmsg(LL_TRACE, "parsing parameters OK\n");
700 mech = lgss_name2mech(uparam.kup_mech);
702 logmsg(LL_ERR, "key %08x: unsupported mech: %s\n",
703 keyid, uparam.kup_mech);
707 if (lgss_mech_initialize(mech)) {
708 logmsg(LL_ERR, "key %08x: can't initialize mech %s\n",
709 keyid, mech->lmt_name);
713 cred = lgss_create_cred(mech);
715 logmsg(LL_ERR, "key %08x: can't create a new %s cred\n",
716 keyid, mech->lmt_name);
720 cred->lc_uid = uparam.kup_uid;
721 cred->lc_root_flags |= uparam.kup_is_root ? LGSS_ROOT_CRED_ROOT : 0;
722 cred->lc_root_flags |= uparam.kup_is_mdt ? LGSS_ROOT_CRED_MDT : 0;
723 cred->lc_root_flags |= uparam.kup_is_ost ? LGSS_ROOT_CRED_OST : 0;
724 cred->lc_tgt_nid = uparam.kup_nid;
725 cred->lc_tgt_svc = uparam.kup_svc;
727 if (lgss_prepare_cred(cred)) {
728 logmsg(LL_ERR, "key %08x: failed to prepare credentials "
729 "for user %d\n", keyid, uparam.kup_uid);
733 /* pre initialize the key. note the keyring linked to is actually of the
734 * original requesting process, not _this_ upcall process. if it's for
735 * root user, don't link to any keyrings because we want fully control
736 * on it, and share it among all root sessions; otherswise link to
739 if (cred->lc_root_flags != 0)
742 inst_keyring = KEY_SPEC_SESSION_KEYRING;
744 if (keyctl_instantiate(keyid, NULL, 0, inst_keyring)) {
745 logmsg(LL_ERR, "instantiate key %08x: %s\n",
746 keyid, strerror(errno));
750 logmsg(LL_TRACE, "instantiated kernel key %08x\n", keyid);
753 * fork a child to do the real gss negotiation
757 logmsg(LL_ERR, "key %08x: can't create child: %s\n",
758 keyid, strerror(errno));
760 } else if (child == 0) {
761 return lgssc_kr_negotiate(keyid, cred, &uparam);
764 logmsg(LL_TRACE, "forked child %d\n", child);