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>
52 #include <gssapi/gssapi.h>
54 #include <libcfs/util/param.h>
55 #include <libcfs/util/string.h>
57 #include "lgss_utils.h"
58 #include "write_bytes.h"
62 * gss target string of lustre service we are negotiating for
64 static char *g_service = NULL;
67 * all data about negotiation
69 struct lgss_nego_data {
70 uint32_t lnd_established:1;
77 gss_OID lnd_mech; /* mech OID */
78 gss_name_t lnd_svc_name; /* service name */
79 unsigned int lnd_req_flags; /* request flags */
80 gss_cred_id_t lnd_cred; /* credential */
81 gss_ctx_id_t lnd_ctx; /* session context */
82 gss_buffer_desc lnd_rmt_ctx; /* remote handle of context */
83 uint32_t lnd_seq_win; /* sequence window */
90 * context creation response
92 struct lgss_init_res {
93 gss_buffer_desc gr_ctx; /* context handle */
94 unsigned int gr_major; /* major status */
95 unsigned int gr_minor; /* minor status */
96 unsigned int gr_win; /* sequence window */
97 gss_buffer_desc gr_token; /* token */
100 struct keyring_upcall_param {
109 uint64_t kup_selfnid;
112 unsigned int kup_is_root:1,
117 /****************************************
118 * child process: gss negotiation *
119 ****************************************/
121 int do_nego_rpc(struct lgss_nego_data *lnd,
122 gss_buffer_desc *gss_token,
123 struct lgss_init_res *gr)
125 struct lgssd_ioctl_param param;
133 logmsg(LL_TRACE, "start negotiation rpc\n");
135 pw = getpwuid(lnd->lnd_uid);
137 logmsg(LL_ERR, "no uid %u in local user database\n",
142 param.version = GSSD_INTERFACE_VERSION;
143 param.secid = lnd->lnd_secid;
144 param.uuid = lnd->lnd_uuid;
145 param.lustre_svc = lnd->lnd_lsvc;
146 param.uid = lnd->lnd_uid;
147 param.gid = pw->pw_gid;
148 param.send_token_size = gss_token->length;
149 param.send_token = (char *) gss_token->value;
150 param.reply_buf_size = sizeof(outbuf);
151 param.reply_buf = outbuf;
153 rc = cfs_get_param_paths(&path, "sptlrpc/gss/init_channel");
157 logmsg(LL_TRACE, "to open %s\n", path.gl_pathv[0]);
159 fd = open(path.gl_pathv[0], O_WRONLY);
161 logmsg(LL_ERR, "can't open %s\n", path.gl_pathv[0]);
166 logmsg(LL_TRACE, "to down-write\n");
168 ret = write(fd, ¶m, sizeof(param));
170 if (ret != sizeof(param)) {
171 logmsg(LL_ERR, "lustre ioctl err: %s\n", strerror(errno));
176 logmsg(LL_TRACE, "do_nego_rpc: to parse reply\n");
178 logmsg(LL_ERR, "status: %ld (%s)\n",
179 param.status, strerror((int)param.status));
181 /* kernel return -ETIMEDOUT means the rpc timedout, we should
182 * notify the caller to reinitiate the gss negotiation, by
183 * returning -ERESTART
185 if (param.status == -ETIMEDOUT)
192 p = (unsigned int *)outbuf;
198 gr->gr_ctx.length = *p++;
199 gr->gr_ctx.value = malloc(gr->gr_ctx.length);
200 memcpy(gr->gr_ctx.value, p, gr->gr_ctx.length);
201 p += (((gr->gr_ctx.length + 3) & ~3) / 4);
203 gr->gr_token.length = *p++;
204 gr->gr_token.value = malloc(gr->gr_token.length);
205 memcpy(gr->gr_token.value, p, gr->gr_token.length);
206 p += (((gr->gr_token.length + 3) & ~3) / 4);
208 logmsg(LL_DEBUG, "do_nego_rpc: receive handle len %zu, token len %zu, "
209 "res %d\n", gr->gr_ctx.length, gr->gr_token.length, res);
211 cfs_free_param_data(&path);
216 * if return error, the lnd_rpc_err or lnd_gss_err is set.
218 static int lgssc_negotiation(struct lgss_nego_data *lnd)
220 struct lgss_init_res gr;
221 gss_buffer_desc *recv_tokenp, send_token;
222 OM_uint32 maj_stat, min_stat, ret_flags;
224 logmsg(LL_TRACE, "start gss negotiation\n");
226 /* GSS context establishment loop. */
227 memset(&gr, 0, sizeof(gr));
228 recv_tokenp = GSS_C_NO_BUFFER;
231 maj_stat = gss_init_sec_context(&min_stat,
240 NULL, /* used mech */
243 NULL); /* time rec */
245 if (recv_tokenp != GSS_C_NO_BUFFER) {
246 gss_release_buffer(&min_stat, &gr.gr_token);
247 recv_tokenp = GSS_C_NO_BUFFER;
250 if (maj_stat != GSS_S_COMPLETE &&
251 maj_stat != GSS_S_CONTINUE_NEEDED) {
252 lnd->lnd_gss_err = maj_stat;
254 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
255 "failed init context");
259 if (send_token.length != 0) {
260 memset(&gr, 0, sizeof(gr));
262 lnd->lnd_rpc_err = do_nego_rpc(lnd, &send_token, &gr);
263 gss_release_buffer(&min_stat, &send_token);
265 if (lnd->lnd_rpc_err) {
266 logmsg(LL_ERR, "negotiation rpc error: %d\n",
271 if (gr.gr_major != GSS_S_COMPLETE &&
272 gr.gr_major != GSS_S_CONTINUE_NEEDED) {
273 lnd->lnd_gss_err = gr.gr_major;
275 logmsg(LL_ERR, "negotiation gss error %x\n",
280 if (gr.gr_ctx.length != 0) {
281 if (lnd->lnd_rmt_ctx.value)
282 gss_release_buffer(&min_stat,
284 lnd->lnd_rmt_ctx = gr.gr_ctx;
287 if (gr.gr_token.length != 0) {
288 if (maj_stat != GSS_S_CONTINUE_NEEDED)
290 recv_tokenp = &gr.gr_token;
294 /* GSS_S_COMPLETE => check gss header verifier,
295 * usually checked in gss_validate
297 if (maj_stat == GSS_S_COMPLETE) {
298 lnd->lnd_established = 1;
299 lnd->lnd_seq_win = gr.gr_win;
304 /* End context negotiation loop. */
305 if (!lnd->lnd_established) {
306 if (gr.gr_token.length != 0)
307 gss_release_buffer(&min_stat, &gr.gr_token);
309 if (lnd->lnd_gss_err == GSS_S_COMPLETE)
310 lnd->lnd_rpc_err = -EACCES;
312 logmsg(LL_ERR, "context negotiation failed\n");
316 logmsg(LL_DEBUG, "successfully negotiated a context\n");
321 * if return error, the lnd_rpc_err or lnd_gss_err is set.
323 static int lgssc_init_nego_data(struct lgss_nego_data *lnd,
324 struct keyring_upcall_param *kup,
327 gss_buffer_desc sname;
328 OM_uint32 maj_stat, min_stat;
330 memset(lnd, 0, sizeof(*lnd));
332 lnd->lnd_secid = kup->kup_secid;
333 lnd->lnd_uid = kup->kup_uid;
334 lnd->lnd_lsvc = kup->kup_svc;
335 lnd->lnd_uuid = kup->kup_tgt;
337 lnd->lnd_established = 0;
338 lnd->lnd_svc_name = GSS_C_NO_NAME;
339 lnd->lnd_cred = GSS_C_NO_CREDENTIAL;
340 lnd->lnd_ctx = GSS_C_NO_CONTEXT;
341 lnd->lnd_rmt_ctx = (gss_buffer_desc) GSS_C_EMPTY_BUFFER;
342 lnd->lnd_seq_win = 0;
346 lnd->lnd_mech = (gss_OID) &krb5oid;
347 lnd->lnd_req_flags = GSS_C_MUTUAL_FLAG;
350 logmsg(LL_ERR, "invalid mech: %d\n", mech);
351 lnd->lnd_rpc_err = -EACCES;
355 sname.value = g_service;
356 sname.length = strlen(g_service);
358 maj_stat = gss_import_name(&min_stat, &sname,
359 (gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
361 if (maj_stat != GSS_S_COMPLETE) {
362 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
363 "can't import svc name");
364 lnd->lnd_gss_err = maj_stat;
371 void lgssc_fini_nego_data(struct lgss_nego_data *lnd)
373 OM_uint32 maj_stat, min_stat;
375 if (lnd->lnd_svc_name != GSS_C_NO_NAME) {
376 maj_stat = gss_release_name(&min_stat, &lnd->lnd_svc_name);
377 if (maj_stat != GSS_S_COMPLETE)
378 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
379 "can't release service name");
382 if (lnd->lnd_cred != GSS_C_NO_CREDENTIAL) {
383 maj_stat = gss_release_cred(&min_stat, &lnd->lnd_cred);
384 if (maj_stat != GSS_S_COMPLETE)
385 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
386 "can't release credential");
391 int error_kernel_key(key_serial_t keyid, int rpc_error, int gss_error)
397 logmsg(LL_TRACE, "revoking kernel key %08x\n", keyid);
400 end = buf + sizeof(buf);
402 WRITE_BYTES(&p, end, seqwin);
403 WRITE_BYTES(&p, end, rpc_error);
404 WRITE_BYTES(&p, end, gss_error);
407 if (keyctl_update(keyid, buf, p - buf)) {
408 if (errno != EAGAIN) {
409 logmsg(LL_ERR, "revoke key %08x: %s\n",
410 keyid, strerror(errno));
414 logmsg(LL_WARN, "key %08x: revoking too soon, try again\n",
420 logmsg(LL_INFO, "key %08x: revoked\n", keyid);
425 int update_kernel_key(key_serial_t keyid,
426 struct lgss_nego_data *lnd,
427 gss_buffer_desc *ctx_token)
429 char *buf = NULL, *p = NULL, *end = NULL;
430 unsigned int buf_size = 0;
433 logmsg(LL_TRACE, "updating kernel key %08x\n", keyid);
435 buf_size = sizeof(lnd->lnd_seq_win) +
436 sizeof(lnd->lnd_rmt_ctx.length) + lnd->lnd_rmt_ctx.length +
437 sizeof(ctx_token->length) + ctx_token->length;
438 buf = malloc(buf_size);
440 logmsg(LL_ERR, "key %08x: can't alloc update buf: size %d\n",
446 end = buf + buf_size;
449 if (WRITE_BYTES(&p, end, lnd->lnd_seq_win))
451 if (write_buffer(&p, end, &lnd->lnd_rmt_ctx))
453 if (write_buffer(&p, end, ctx_token))
457 if (keyctl_update(keyid, buf, p - buf)) {
458 if (errno != EAGAIN) {
459 logmsg(LL_ERR, "update key %08x: %s\n",
460 keyid, strerror(errno));
464 logmsg(LL_DEBUG, "key %08x: updating too soon, try again\n",
471 logmsg(LL_DEBUG, "key %08x: updated\n", keyid);
478 * note we inherited assumed authority from parent process
480 static int lgssc_kr_negotiate(key_serial_t keyid, struct lgss_cred *cred,
481 struct keyring_upcall_param *kup)
483 struct lgss_nego_data lnd;
484 gss_buffer_desc token = GSS_C_EMPTY_BUFFER;
488 logmsg(LL_TRACE, "child start on behalf of key %08x: "
489 "cred %p, uid %u, svc %u, nid %"PRIx64", uids: %u:%u/%u:%u\n",
490 keyid, cred, cred->lc_uid, cred->lc_tgt_svc, cred->lc_tgt_nid,
491 kup->kup_uid, kup->kup_gid, kup->kup_fsuid, kup->kup_fsgid);
493 if (lgss_get_service_str(&g_service, kup->kup_svc, kup->kup_nid)) {
494 logmsg(LL_ERR, "key %08x: failed to construct service "
496 error_kernel_key(keyid, -EACCES, 0);
500 if (lgss_using_cred(cred)) {
501 logmsg(LL_ERR, "key %08x: can't using cred\n", keyid);
502 error_kernel_key(keyid, -EACCES, 0);
506 if (lgssc_init_nego_data(&lnd, kup, cred->lc_mech->lmt_mech_n)) {
507 logmsg(LL_ERR, "key %08x: failed to initialize "
508 "negotiation data\n", keyid);
509 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
513 rc = lgssc_negotiation(&lnd);
515 logmsg(LL_ERR, "key %08x: failed to negotiation\n", keyid);
516 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
520 rc = serialize_context_for_kernel(lnd.lnd_ctx, &token, lnd.lnd_mech);
522 logmsg(LL_ERR, "key %08x: failed to export context\n", keyid);
523 error_kernel_key(keyid, rc, lnd.lnd_gss_err);
527 rc = update_kernel_key(keyid, &lnd, &token);
532 logmsg(LL_INFO, "key %08x for user %u is updated OK!\n",
533 keyid, kup->kup_uid);
535 if (token.length != 0)
536 gss_release_buffer(&min_stat, &token);
538 lgssc_fini_nego_data(&lnd);
541 lgss_release_cred(cred);
546 * call out info format: s[:s]...
548 * [1]: mech_name (string)
551 * [4]: flags (string) FMT: r-root; m-mdt; o-ost
552 * [5]: lustre_svc (uint)
553 * [6]: target_nid (uint64)
554 * [7]: target_uuid (string)
555 * [8]: self_nid (uint64)
557 static int parse_callout_info(const char *coinfo,
558 struct keyring_upcall_param *uparam)
567 length = strlen(coinfo) + 1;
569 logmsg(LL_ERR, "coinfo too long\n");
572 memcpy(buf, coinfo, length);
574 for (i = 0; i < nargs - 1; i++) {
575 pos = strchr(string, ':');
577 logmsg(LL_ERR, "short of components\n");
587 logmsg(LL_TRACE, "components: %s,%s,%s,%s,%s,%s,%s,%s,%s\n",
588 data[0], data[1], data[2], data[3], data[4], data[5],
589 data[6], data[7], data[8]);
591 uparam->kup_secid = strtol(data[0], NULL, 0);
592 strlcpy(uparam->kup_mech, data[1], sizeof(uparam->kup_mech));
593 uparam->kup_uid = strtol(data[2], NULL, 0);
594 uparam->kup_gid = strtol(data[3], NULL, 0);
595 if (strchr(data[4], 'r'))
596 uparam->kup_is_root = 1;
597 if (strchr(data[4], 'm'))
598 uparam->kup_is_mdt = 1;
599 if (strchr(data[4], 'o'))
600 uparam->kup_is_ost = 1;
601 uparam->kup_svc = strtol(data[5], NULL, 0);
602 uparam->kup_nid = strtoll(data[6], NULL, 0);
603 strlcpy(uparam->kup_tgt, data[7], sizeof(uparam->kup_tgt));
604 uparam->kup_selfnid = strtoll(data[8], NULL, 0);
606 logmsg(LL_DEBUG, "parse call out info: secid %d, mech %s, ugid %u:%u, "
607 "is_root %d, is_mdt %d, is_ost %d, svc %d, nid 0x%"PRIx64", "
608 "tgt %s, self nid 0x%"PRIx64"\n",
609 uparam->kup_secid, uparam->kup_mech,
610 uparam->kup_uid, uparam->kup_gid,
611 uparam->kup_is_root, uparam->kup_is_mdt, uparam->kup_is_ost,
612 uparam->kup_svc, uparam->kup_nid, uparam->kup_tgt,
613 uparam->kup_selfnid);
617 static void set_log_level()
623 if (cfs_get_param_paths(&path,
624 "sptlrpc/gss/lgss_keyring/debug_level") != 0)
626 file = fopen(path.gl_pathv[0], "r");
628 cfs_free_param_data(&path);
632 if (fscanf(file, "%u", &level) != 1)
638 lgss_set_loglevel(level);
640 cfs_free_param_data(&path);
644 /****************************************
646 ****************************************/
648 int main(int argc, char *argv[])
650 struct keyring_upcall_param uparam;
653 key_serial_t inst_keyring;
655 struct lgss_mech_type *mech;
656 struct lgss_cred *cred;
660 logmsg(LL_TRACE, "start parsing parameters\n");
662 * parse & sanity check upcall parameters
663 * expected to be called with:
667 * [4]: key description
671 * [8]: thread keyring
672 * [9]: process keyring
673 * [10]: session keyring
675 if (argc != 10 + 1) {
676 logmsg(LL_ERR, "invalid parameter number %d\n", argc);
680 logmsg(LL_INFO, "key %s, desc %s, ugid %s:%s, sring %s, coinfo %s\n",
681 argv[2], argv[4], argv[6], argv[7], argv[10], argv[5]);
683 memset(&uparam, 0, sizeof(uparam));
685 if (strcmp(argv[1], "create") != 0) {
686 logmsg(LL_ERR, "invalid OP %s\n", argv[1]);
690 if (sscanf(argv[2], "%d", &keyid) != 1) {
691 logmsg(LL_ERR, "can't extract KeyID: %s\n", argv[2]);
695 if (sscanf(argv[6], "%d", &uparam.kup_fsuid) != 1) {
696 logmsg(LL_ERR, "can't extract UID: %s\n", argv[6]);
700 if (sscanf(argv[7], "%d", &uparam.kup_fsgid) != 1) {
701 logmsg(LL_ERR, "can't extract GID: %s\n", argv[7]);
705 if (sscanf(argv[10], "%d", &sring) != 1) {
706 logmsg(LL_ERR, "can't extract session keyring: %s\n", argv[10]);
710 if (parse_callout_info(argv[5], &uparam)) {
711 logmsg(LL_ERR, "can't extract callout info: %s\n", argv[5]);
715 logmsg(LL_TRACE, "parsing parameters OK\n");
720 mech = lgss_name2mech(uparam.kup_mech);
722 logmsg(LL_ERR, "key %08x: unsupported mech: %s\n",
723 keyid, uparam.kup_mech);
727 if (lgss_mech_initialize(mech)) {
728 logmsg(LL_ERR, "key %08x: can't initialize mech %s\n",
729 keyid, mech->lmt_name);
733 cred = lgss_create_cred(mech);
735 logmsg(LL_ERR, "key %08x: can't create a new %s cred\n",
736 keyid, mech->lmt_name);
740 cred->lc_uid = uparam.kup_uid;
741 cred->lc_root_flags |= uparam.kup_is_root ? LGSS_ROOT_CRED_ROOT : 0;
742 cred->lc_root_flags |= uparam.kup_is_mdt ? LGSS_ROOT_CRED_MDT : 0;
743 cred->lc_root_flags |= uparam.kup_is_ost ? LGSS_ROOT_CRED_OST : 0;
744 cred->lc_tgt_nid = uparam.kup_nid;
745 cred->lc_tgt_svc = uparam.kup_svc;
746 cred->lc_self_nid = uparam.kup_selfnid;
748 if (lgss_prepare_cred(cred)) {
749 logmsg(LL_ERR, "key %08x: failed to prepare credentials "
750 "for user %d\n", keyid, uparam.kup_uid);
754 /* pre initialize the key. note the keyring linked to is actually of the
755 * original requesting process, not _this_ upcall process. if it's for
756 * root user, don't link to any keyrings because we want fully control
757 * on it, and share it among all root sessions; otherswise link to
760 if (cred->lc_root_flags != 0)
763 inst_keyring = KEY_SPEC_SESSION_KEYRING;
765 if (keyctl_instantiate(keyid, NULL, 0, inst_keyring)) {
766 logmsg(LL_ERR, "instantiate key %08x: %s\n",
767 keyid, strerror(errno));
771 logmsg(LL_TRACE, "instantiated kernel key %08x\n", keyid);
774 * fork a child to do the real gss negotiation
778 logmsg(LL_ERR, "key %08x: can't create child: %s\n",
779 keyid, strerror(errno));
781 } else if (child == 0) {
782 return lgssc_kr_negotiate(keyid, cred, &uparam);
785 logmsg(LL_TRACE, "forked child %d\n", child);