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/string.h>
56 #include "lgss_utils.h"
57 #include "write_bytes.h"
61 * gss target string of lustre service we are negotiating for
63 static char *g_service = NULL;
66 * all data about negotiation
68 struct lgss_nego_data {
69 uint32_t lnd_established:1;
76 gss_OID lnd_mech; /* mech OID */
77 gss_name_t lnd_svc_name; /* service name */
78 unsigned int lnd_req_flags; /* request flags */
79 gss_cred_id_t lnd_cred; /* credential */
80 gss_ctx_id_t lnd_ctx; /* session context */
81 gss_buffer_desc lnd_rmt_ctx; /* remote handle of context */
82 uint32_t lnd_seq_win; /* sequence window */
89 * context creation response
91 struct lgss_init_res {
92 gss_buffer_desc gr_ctx; /* context handle */
93 unsigned int gr_major; /* major status */
94 unsigned int gr_minor; /* minor status */
95 unsigned int gr_win; /* sequence window */
96 gss_buffer_desc gr_token; /* token */
99 struct keyring_upcall_param {
108 uint64_t kup_selfnid;
111 unsigned int kup_is_root:1,
116 /****************************************
117 * child process: gss negotiation *
118 ****************************************/
120 #define INIT_CHANNEL "/proc/fs/lustre/sptlrpc/gss/init_channel"
122 int do_nego_rpc(struct lgss_nego_data *lnd,
123 gss_buffer_desc *gss_token,
124 struct lgss_init_res *gr)
126 struct lgssd_ioctl_param param;
132 logmsg(LL_TRACE, "start negotiation rpc\n");
134 pw = getpwuid(lnd->lnd_uid);
136 logmsg(LL_ERR, "no uid %u in local user database\n",
141 param.version = GSSD_INTERFACE_VERSION;
142 param.secid = lnd->lnd_secid;
143 param.uuid = lnd->lnd_uuid;
144 param.lustre_svc = lnd->lnd_lsvc;
145 param.uid = lnd->lnd_uid;
146 param.gid = pw->pw_gid;
147 param.send_token_size = gss_token->length;
148 param.send_token = (char *) gss_token->value;
149 param.reply_buf_size = sizeof(outbuf);
150 param.reply_buf = outbuf;
152 logmsg(LL_TRACE, "to open " INIT_CHANNEL "\n");
154 fd = open(INIT_CHANNEL, O_WRONLY);
156 logmsg(LL_ERR, "can't open " INIT_CHANNEL "\n");
160 logmsg(LL_TRACE, "to down-write\n");
162 ret = write(fd, ¶m, sizeof(param));
163 if (ret != sizeof(param)) {
164 logmsg(LL_ERR, "lustre ioctl err: %s\n", strerror(errno));
170 logmsg(LL_TRACE, "do_nego_rpc: to parse reply\n");
172 logmsg(LL_ERR, "status: %ld (%s)\n",
173 param.status, strerror((int)param.status));
175 /* kernel return -ETIMEDOUT means the rpc timedout, we should
176 * notify the caller to reinitiate the gss negotiation, by
177 * returning -ERESTART
179 if (param.status == -ETIMEDOUT)
185 p = (unsigned int *)outbuf;
191 gr->gr_ctx.length = *p++;
192 gr->gr_ctx.value = malloc(gr->gr_ctx.length);
193 memcpy(gr->gr_ctx.value, p, gr->gr_ctx.length);
194 p += (((gr->gr_ctx.length + 3) & ~3) / 4);
196 gr->gr_token.length = *p++;
197 gr->gr_token.value = malloc(gr->gr_token.length);
198 memcpy(gr->gr_token.value, p, gr->gr_token.length);
199 p += (((gr->gr_token.length + 3) & ~3) / 4);
201 logmsg(LL_DEBUG, "do_nego_rpc: receive handle len %zu, token len %zu, "
202 "res %d\n", gr->gr_ctx.length, gr->gr_token.length, res);
207 * if return error, the lnd_rpc_err or lnd_gss_err is set.
209 static int lgssc_negotiation(struct lgss_nego_data *lnd)
211 struct lgss_init_res gr;
212 gss_buffer_desc *recv_tokenp, send_token;
213 OM_uint32 maj_stat, min_stat, ret_flags;
215 logmsg(LL_TRACE, "start gss negotiation\n");
217 /* GSS context establishment loop. */
218 memset(&gr, 0, sizeof(gr));
219 recv_tokenp = GSS_C_NO_BUFFER;
222 maj_stat = gss_init_sec_context(&min_stat,
231 NULL, /* used mech */
234 NULL); /* time rec */
236 if (recv_tokenp != GSS_C_NO_BUFFER) {
237 gss_release_buffer(&min_stat, &gr.gr_token);
238 recv_tokenp = GSS_C_NO_BUFFER;
241 if (maj_stat != GSS_S_COMPLETE &&
242 maj_stat != GSS_S_CONTINUE_NEEDED) {
243 lnd->lnd_gss_err = maj_stat;
245 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
246 "failed init context");
250 if (send_token.length != 0) {
251 memset(&gr, 0, sizeof(gr));
253 lnd->lnd_rpc_err = do_nego_rpc(lnd, &send_token, &gr);
254 gss_release_buffer(&min_stat, &send_token);
256 if (lnd->lnd_rpc_err) {
257 logmsg(LL_ERR, "negotiation rpc error: %d\n",
262 if (gr.gr_major != GSS_S_COMPLETE &&
263 gr.gr_major != GSS_S_CONTINUE_NEEDED) {
264 lnd->lnd_gss_err = gr.gr_major;
266 logmsg(LL_ERR, "negotiation gss error %x\n",
271 if (gr.gr_ctx.length != 0) {
272 if (lnd->lnd_rmt_ctx.value)
273 gss_release_buffer(&min_stat,
275 lnd->lnd_rmt_ctx = gr.gr_ctx;
278 if (gr.gr_token.length != 0) {
279 if (maj_stat != GSS_S_CONTINUE_NEEDED)
281 recv_tokenp = &gr.gr_token;
285 /* GSS_S_COMPLETE => check gss header verifier,
286 * usually checked in gss_validate
288 if (maj_stat == GSS_S_COMPLETE) {
289 lnd->lnd_established = 1;
290 lnd->lnd_seq_win = gr.gr_win;
295 /* End context negotiation loop. */
296 if (!lnd->lnd_established) {
297 if (gr.gr_token.length != 0)
298 gss_release_buffer(&min_stat, &gr.gr_token);
300 if (lnd->lnd_gss_err == GSS_S_COMPLETE)
301 lnd->lnd_rpc_err = -EACCES;
303 logmsg(LL_ERR, "context negotiation failed\n");
307 logmsg(LL_DEBUG, "successfully negotiated a context\n");
312 * if return error, the lnd_rpc_err or lnd_gss_err is set.
314 static int lgssc_init_nego_data(struct lgss_nego_data *lnd,
315 struct keyring_upcall_param *kup,
318 gss_buffer_desc sname;
319 OM_uint32 maj_stat, min_stat;
321 memset(lnd, 0, sizeof(*lnd));
323 lnd->lnd_secid = kup->kup_secid;
324 lnd->lnd_uid = kup->kup_uid;
325 lnd->lnd_lsvc = kup->kup_svc;
326 lnd->lnd_uuid = kup->kup_tgt;
328 lnd->lnd_established = 0;
329 lnd->lnd_svc_name = GSS_C_NO_NAME;
330 lnd->lnd_cred = GSS_C_NO_CREDENTIAL;
331 lnd->lnd_ctx = GSS_C_NO_CONTEXT;
332 lnd->lnd_rmt_ctx = (gss_buffer_desc) GSS_C_EMPTY_BUFFER;
333 lnd->lnd_seq_win = 0;
337 lnd->lnd_mech = (gss_OID) &krb5oid;
338 lnd->lnd_req_flags = GSS_C_MUTUAL_FLAG;
341 logmsg(LL_ERR, "invalid mech: %d\n", mech);
342 lnd->lnd_rpc_err = -EACCES;
346 sname.value = g_service;
347 sname.length = strlen(g_service);
349 maj_stat = gss_import_name(&min_stat, &sname,
350 (gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
352 if (maj_stat != GSS_S_COMPLETE) {
353 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
354 "can't import svc name");
355 lnd->lnd_gss_err = maj_stat;
362 void lgssc_fini_nego_data(struct lgss_nego_data *lnd)
364 OM_uint32 maj_stat, min_stat;
366 if (lnd->lnd_svc_name != GSS_C_NO_NAME) {
367 maj_stat = gss_release_name(&min_stat, &lnd->lnd_svc_name);
368 if (maj_stat != GSS_S_COMPLETE)
369 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
370 "can't release service name");
373 if (lnd->lnd_cred != GSS_C_NO_CREDENTIAL) {
374 maj_stat = gss_release_cred(&min_stat, &lnd->lnd_cred);
375 if (maj_stat != GSS_S_COMPLETE)
376 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
377 "can't release credential");
382 int error_kernel_key(key_serial_t keyid, int rpc_error, int gss_error)
388 logmsg(LL_TRACE, "revoking kernel key %08x\n", keyid);
391 end = buf + sizeof(buf);
393 WRITE_BYTES(&p, end, seqwin);
394 WRITE_BYTES(&p, end, rpc_error);
395 WRITE_BYTES(&p, end, gss_error);
398 if (keyctl_update(keyid, buf, p - buf)) {
399 if (errno != EAGAIN) {
400 logmsg(LL_ERR, "revoke key %08x: %s\n",
401 keyid, strerror(errno));
405 logmsg(LL_WARN, "key %08x: revoking too soon, try again\n",
411 logmsg(LL_INFO, "key %08x: revoked\n", keyid);
416 int update_kernel_key(key_serial_t keyid,
417 struct lgss_nego_data *lnd,
418 gss_buffer_desc *ctx_token)
420 char *buf = NULL, *p = NULL, *end = NULL;
421 unsigned int buf_size = 0;
424 logmsg(LL_TRACE, "updating kernel key %08x\n", keyid);
426 buf_size = sizeof(lnd->lnd_seq_win) +
427 sizeof(lnd->lnd_rmt_ctx.length) + lnd->lnd_rmt_ctx.length +
428 sizeof(ctx_token->length) + ctx_token->length;
429 buf = malloc(buf_size);
431 logmsg(LL_ERR, "key %08x: can't alloc update buf: size %d\n",
437 end = buf + buf_size;
440 if (WRITE_BYTES(&p, end, lnd->lnd_seq_win))
442 if (write_buffer(&p, end, &lnd->lnd_rmt_ctx))
444 if (write_buffer(&p, end, ctx_token))
448 if (keyctl_update(keyid, buf, p - buf)) {
449 if (errno != EAGAIN) {
450 logmsg(LL_ERR, "update key %08x: %s\n",
451 keyid, strerror(errno));
455 logmsg(LL_DEBUG, "key %08x: updating too soon, try again\n",
462 logmsg(LL_DEBUG, "key %08x: updated\n", keyid);
469 * note we inherited assumed authority from parent process
471 static int lgssc_kr_negotiate(key_serial_t keyid, struct lgss_cred *cred,
472 struct keyring_upcall_param *kup)
474 struct lgss_nego_data lnd;
475 gss_buffer_desc token = GSS_C_EMPTY_BUFFER;
479 logmsg(LL_TRACE, "child start on behalf of key %08x: "
480 "cred %p, uid %u, svc %u, nid %"PRIx64", uids: %u:%u/%u:%u\n",
481 keyid, cred, cred->lc_uid, cred->lc_tgt_svc, cred->lc_tgt_nid,
482 kup->kup_uid, kup->kup_gid, kup->kup_fsuid, kup->kup_fsgid);
484 if (lgss_get_service_str(&g_service, kup->kup_svc, kup->kup_nid)) {
485 logmsg(LL_ERR, "key %08x: failed to construct service "
487 error_kernel_key(keyid, -EACCES, 0);
491 if (lgss_using_cred(cred)) {
492 logmsg(LL_ERR, "key %08x: can't using cred\n", keyid);
493 error_kernel_key(keyid, -EACCES, 0);
497 if (lgssc_init_nego_data(&lnd, kup, cred->lc_mech->lmt_mech_n)) {
498 logmsg(LL_ERR, "key %08x: failed to initialize "
499 "negotiation data\n", keyid);
500 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
504 rc = lgssc_negotiation(&lnd);
506 logmsg(LL_ERR, "key %08x: failed to negotiation\n", keyid);
507 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
511 rc = serialize_context_for_kernel(lnd.lnd_ctx, &token, lnd.lnd_mech);
513 logmsg(LL_ERR, "key %08x: failed to export context\n", keyid);
514 error_kernel_key(keyid, rc, lnd.lnd_gss_err);
518 rc = update_kernel_key(keyid, &lnd, &token);
523 logmsg(LL_INFO, "key %08x for user %u is updated OK!\n",
524 keyid, kup->kup_uid);
526 if (token.length != 0)
527 gss_release_buffer(&min_stat, &token);
529 lgssc_fini_nego_data(&lnd);
532 lgss_release_cred(cred);
537 * call out info format: s[:s]...
539 * [1]: mech_name (string)
542 * [4]: flags (string) FMT: r-root; m-mdt; o-ost
543 * [5]: lustre_svc (uint)
544 * [6]: target_nid (uint64)
545 * [7]: target_uuid (string)
546 * [8]: self_nid (uint64)
548 static int parse_callout_info(const char *coinfo,
549 struct keyring_upcall_param *uparam)
558 length = strlen(coinfo) + 1;
560 logmsg(LL_ERR, "coinfo too long\n");
563 memcpy(buf, coinfo, length);
565 for (i = 0; i < nargs - 1; i++) {
566 pos = strchr(string, ':');
568 logmsg(LL_ERR, "short of components\n");
578 logmsg(LL_TRACE, "components: %s,%s,%s,%s,%s,%s,%s,%s,%s\n",
579 data[0], data[1], data[2], data[3], data[4], data[5],
580 data[6], data[7], data[8]);
582 uparam->kup_secid = strtol(data[0], NULL, 0);
583 strlcpy(uparam->kup_mech, data[1], sizeof(uparam->kup_mech));
584 uparam->kup_uid = strtol(data[2], NULL, 0);
585 uparam->kup_gid = strtol(data[3], NULL, 0);
586 if (strchr(data[4], 'r'))
587 uparam->kup_is_root = 1;
588 if (strchr(data[4], 'm'))
589 uparam->kup_is_mdt = 1;
590 if (strchr(data[4], 'o'))
591 uparam->kup_is_ost = 1;
592 uparam->kup_svc = strtol(data[5], NULL, 0);
593 uparam->kup_nid = strtoll(data[6], NULL, 0);
594 strlcpy(uparam->kup_tgt, data[7], sizeof(uparam->kup_tgt));
595 uparam->kup_selfnid = strtoll(data[8], NULL, 0);
597 logmsg(LL_DEBUG, "parse call out info: secid %d, mech %s, ugid %u:%u, "
598 "is_root %d, is_mdt %d, is_ost %d, svc %d, nid 0x%"PRIx64", "
599 "tgt %s, self nid 0x%"PRIx64"\n",
600 uparam->kup_secid, uparam->kup_mech,
601 uparam->kup_uid, uparam->kup_gid,
602 uparam->kup_is_root, uparam->kup_is_mdt, uparam->kup_is_ost,
603 uparam->kup_svc, uparam->kup_nid, uparam->kup_tgt,
604 uparam->kup_selfnid);
608 #define LOG_LEVEL_PATH "/proc/fs/lustre/sptlrpc/gss/lgss_keyring/debug_level"
610 static void set_log_level()
615 file = fopen(LOG_LEVEL_PATH, "r");
619 if (fscanf(file, "%u", &level) != 1)
625 lgss_set_loglevel(level);
630 /****************************************
632 ****************************************/
634 int main(int argc, char *argv[])
636 struct keyring_upcall_param uparam;
639 key_serial_t inst_keyring;
641 struct lgss_mech_type *mech;
642 struct lgss_cred *cred;
646 logmsg(LL_TRACE, "start parsing parameters\n");
648 * parse & sanity check upcall parameters
649 * expected to be called with:
653 * [4]: key description
657 * [8]: thread keyring
658 * [9]: process keyring
659 * [10]: session keyring
661 if (argc != 10 + 1) {
662 logmsg(LL_ERR, "invalid parameter number %d\n", argc);
666 logmsg(LL_INFO, "key %s, desc %s, ugid %s:%s, sring %s, coinfo %s\n",
667 argv[2], argv[4], argv[6], argv[7], argv[10], argv[5]);
669 memset(&uparam, 0, sizeof(uparam));
671 if (strcmp(argv[1], "create") != 0) {
672 logmsg(LL_ERR, "invalid OP %s\n", argv[1]);
676 if (sscanf(argv[2], "%d", &keyid) != 1) {
677 logmsg(LL_ERR, "can't extract KeyID: %s\n", argv[2]);
681 if (sscanf(argv[6], "%d", &uparam.kup_fsuid) != 1) {
682 logmsg(LL_ERR, "can't extract UID: %s\n", argv[6]);
686 if (sscanf(argv[7], "%d", &uparam.kup_fsgid) != 1) {
687 logmsg(LL_ERR, "can't extract GID: %s\n", argv[7]);
691 if (sscanf(argv[10], "%d", &sring) != 1) {
692 logmsg(LL_ERR, "can't extract session keyring: %s\n", argv[10]);
696 if (parse_callout_info(argv[5], &uparam)) {
697 logmsg(LL_ERR, "can't extract callout info: %s\n", argv[5]);
701 logmsg(LL_TRACE, "parsing parameters OK\n");
706 mech = lgss_name2mech(uparam.kup_mech);
708 logmsg(LL_ERR, "key %08x: unsupported mech: %s\n",
709 keyid, uparam.kup_mech);
713 if (lgss_mech_initialize(mech)) {
714 logmsg(LL_ERR, "key %08x: can't initialize mech %s\n",
715 keyid, mech->lmt_name);
719 cred = lgss_create_cred(mech);
721 logmsg(LL_ERR, "key %08x: can't create a new %s cred\n",
722 keyid, mech->lmt_name);
726 cred->lc_uid = uparam.kup_uid;
727 cred->lc_root_flags |= uparam.kup_is_root ? LGSS_ROOT_CRED_ROOT : 0;
728 cred->lc_root_flags |= uparam.kup_is_mdt ? LGSS_ROOT_CRED_MDT : 0;
729 cred->lc_root_flags |= uparam.kup_is_ost ? LGSS_ROOT_CRED_OST : 0;
730 cred->lc_tgt_nid = uparam.kup_nid;
731 cred->lc_tgt_svc = uparam.kup_svc;
732 cred->lc_self_nid = uparam.kup_selfnid;
734 if (lgss_prepare_cred(cred)) {
735 logmsg(LL_ERR, "key %08x: failed to prepare credentials "
736 "for user %d\n", keyid, uparam.kup_uid);
740 /* pre initialize the key. note the keyring linked to is actually of the
741 * original requesting process, not _this_ upcall process. if it's for
742 * root user, don't link to any keyrings because we want fully control
743 * on it, and share it among all root sessions; otherswise link to
746 if (cred->lc_root_flags != 0)
749 inst_keyring = KEY_SPEC_SESSION_KEYRING;
751 if (keyctl_instantiate(keyid, NULL, 0, inst_keyring)) {
752 logmsg(LL_ERR, "instantiate key %08x: %s\n",
753 keyid, strerror(errno));
757 logmsg(LL_TRACE, "instantiated kernel key %08x\n", keyid);
760 * fork a child to do the real gss negotiation
764 logmsg(LL_ERR, "key %08x: can't create child: %s\n",
765 keyid, strerror(errno));
767 } else if (child == 0) {
768 return lgssc_kr_negotiate(keyid, cred, &uparam);
771 logmsg(LL_TRACE, "forked child %d\n", child);