1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
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>
54 #include "lgss_utils.h"
55 #include "write_bytes.h"
59 * gss target string of lustre service we are negotiating for
61 static char *g_service = NULL;
64 * all data about negotiation
66 struct lgss_nego_data {
67 uint32_t lnd_established:1;
74 gss_OID lnd_mech; /* mech OID */
75 gss_name_t lnd_svc_name; /* service name */
76 u_int lnd_req_flags; /* request flags */
77 gss_cred_id_t lnd_cred; /* credential */
78 gss_ctx_id_t lnd_ctx; /* session context */
79 gss_buffer_desc lnd_rmt_ctx; /* remote handle of context */
80 uint32_t lnd_seq_win; /* sequence window */
87 * context creation response
89 struct lgss_init_res {
90 gss_buffer_desc gr_ctx; /* context handle */
91 u_int gr_major; /* major status */
92 u_int gr_minor; /* minor status */
93 u_int gr_win; /* sequence window */
94 gss_buffer_desc gr_token; /* token */
97 struct keyring_upcall_param {
112 /****************************************
113 * child process: gss negotiation *
114 ****************************************/
116 #define INIT_CHANNEL "/proc/fs/lustre/sptlrpc/gss/init_channel"
118 int do_nego_rpc(struct lgss_nego_data *lnd,
119 gss_buffer_desc *gss_token,
120 struct lgss_init_res *gr)
122 struct lgssd_ioctl_param param;
128 logmsg(LL_TRACE, "start negotiation rpc\n");
130 pw = getpwuid(lnd->lnd_uid);
132 logmsg(LL_ERR, "no uid %u in local user database\n",
137 param.version = GSSD_INTERFACE_VERSION;
138 param.secid = lnd->lnd_secid;
139 param.uuid = lnd->lnd_uuid;
140 param.lustre_svc = lnd->lnd_lsvc;
141 param.uid = lnd->lnd_uid;
142 param.gid = pw->pw_gid;
143 param.send_token_size = gss_token->length;
144 param.send_token = (char *) gss_token->value;
145 param.reply_buf_size = sizeof(outbuf);
146 param.reply_buf = outbuf;
148 logmsg(LL_TRACE, "to open " INIT_CHANNEL "\n");
150 fd = open(INIT_CHANNEL, O_WRONLY);
152 logmsg(LL_ERR, "can't open " INIT_CHANNEL "\n");
156 logmsg(LL_TRACE, "to down-write\n");
158 ret = write(fd, ¶m, sizeof(param));
159 if (ret != sizeof(param)) {
160 logmsg(LL_ERR, "lustre ioctl err: %d\n", strerror(errno));
166 logmsg(LL_TRACE, "do_nego_rpc: to parse reply\n");
168 logmsg(LL_ERR, "status: %d (%s)\n",
169 param.status, strerror((int)param.status));
171 /* kernel return -ETIMEDOUT means the rpc timedout, we should
172 * notify the caller to reinitiate the gss negotiation, by
173 * returning -ERESTART
175 if (param.status == -ETIMEDOUT)
181 p = (unsigned int *)outbuf;
187 gr->gr_ctx.length = *p++;
188 gr->gr_ctx.value = malloc(gr->gr_ctx.length);
189 memcpy(gr->gr_ctx.value, p, gr->gr_ctx.length);
190 p += (((gr->gr_ctx.length + 3) & ~3) / 4);
192 gr->gr_token.length = *p++;
193 gr->gr_token.value = malloc(gr->gr_token.length);
194 memcpy(gr->gr_token.value, p, gr->gr_token.length);
195 p += (((gr->gr_token.length + 3) & ~3) / 4);
197 logmsg(LL_DEBUG, "do_nego_rpc: receive handle len %d, token len %d\n",
198 gr->gr_ctx.length, gr->gr_token.length);
203 * if return error, the lnd_rpc_err or lnd_gss_err is set.
205 static int lgssc_negotiation(struct lgss_nego_data *lnd)
207 struct lgss_init_res gr;
208 gss_buffer_desc *recv_tokenp, send_token;
209 OM_uint32 maj_stat, min_stat, ret_flags;
211 logmsg(LL_TRACE, "start gss negotiation\n");
213 /* GSS context establishment loop. */
214 memset(&gr, 0, sizeof(gr));
215 recv_tokenp = GSS_C_NO_BUFFER;
218 maj_stat = gss_init_sec_context(&min_stat,
227 NULL, /* used mech */
230 NULL); /* time rec */
232 if (recv_tokenp != GSS_C_NO_BUFFER) {
233 gss_release_buffer(&min_stat, &gr.gr_token);
234 recv_tokenp = GSS_C_NO_BUFFER;
237 if (maj_stat != GSS_S_COMPLETE &&
238 maj_stat != GSS_S_CONTINUE_NEEDED) {
239 lnd->lnd_gss_err = maj_stat;
241 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
242 "failed init context");
246 if (send_token.length != 0) {
247 memset(&gr, 0, sizeof(gr));
249 lnd->lnd_rpc_err = do_nego_rpc(lnd, &send_token, &gr);
250 gss_release_buffer(&min_stat, &send_token);
252 if (lnd->lnd_rpc_err) {
253 logmsg(LL_ERR, "negotiation rpc error: %d\n",
258 if (gr.gr_major != GSS_S_COMPLETE &&
259 gr.gr_major != GSS_S_CONTINUE_NEEDED) {
260 lnd->lnd_gss_err = gr.gr_major;
262 logmsg(LL_ERR, "negotiation gss error %x\n",
267 if (gr.gr_ctx.length != 0) {
268 if (lnd->lnd_rmt_ctx.value)
269 gss_release_buffer(&min_stat,
271 lnd->lnd_rmt_ctx = gr.gr_ctx;
274 if (gr.gr_token.length != 0) {
275 if (maj_stat != GSS_S_CONTINUE_NEEDED)
277 recv_tokenp = &gr.gr_token;
281 /* GSS_S_COMPLETE => check gss header verifier,
282 * usually checked in gss_validate
284 if (maj_stat == GSS_S_COMPLETE) {
285 lnd->lnd_established = 1;
286 lnd->lnd_seq_win = gr.gr_win;
291 /* End context negotiation loop. */
292 if (!lnd->lnd_established) {
293 if (gr.gr_token.length != 0)
294 gss_release_buffer(&min_stat, &gr.gr_token);
296 if (lnd->lnd_gss_err == GSS_S_COMPLETE)
297 lnd->lnd_rpc_err = -EACCES;
299 logmsg(LL_ERR, "context negotiation failed\n");
303 logmsg(LL_DEBUG, "successfully negotiated a context\n");
308 * if return error, the lnd_rpc_err or lnd_gss_err is set.
310 static int lgssc_init_nego_data(struct lgss_nego_data *lnd,
311 struct keyring_upcall_param *kup,
314 gss_buffer_desc sname;
315 OM_uint32 maj_stat, min_stat;
317 memset(lnd, 0, sizeof(*lnd));
319 lnd->lnd_secid = kup->kup_secid;
320 lnd->lnd_uid = kup->kup_uid;
321 lnd->lnd_lsvc = kup->kup_svc;
322 lnd->lnd_uuid = kup->kup_tgt;
324 lnd->lnd_established = 0;
325 lnd->lnd_svc_name = GSS_C_NO_NAME;
326 lnd->lnd_cred = GSS_C_NO_CREDENTIAL;
327 lnd->lnd_ctx = GSS_C_NO_CONTEXT;
328 lnd->lnd_rmt_ctx = (gss_buffer_desc) GSS_C_EMPTY_BUFFER;
329 lnd->lnd_seq_win = 0;
333 lnd->lnd_mech = (gss_OID) &krb5oid;
334 lnd->lnd_req_flags = GSS_C_MUTUAL_FLAG;
337 logmsg(LL_ERR, "invalid mech: %d\n", mech);
338 lnd->lnd_rpc_err = -EACCES;
342 sname.value = g_service;
343 sname.length = strlen(g_service);
345 maj_stat = gss_import_name(&min_stat, &sname,
346 (gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
348 if (maj_stat != GSS_S_COMPLETE) {
349 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
350 "can't import svc name");
351 lnd->lnd_gss_err = maj_stat;
358 void lgssc_fini_nego_data(struct lgss_nego_data *lnd)
360 OM_uint32 maj_stat, min_stat;
362 if (lnd->lnd_svc_name != GSS_C_NO_NAME) {
363 maj_stat = gss_release_name(&min_stat, &lnd->lnd_svc_name);
364 if (maj_stat != GSS_S_COMPLETE)
365 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
366 "can't release service name");
369 if (lnd->lnd_cred != GSS_C_NO_CREDENTIAL) {
370 maj_stat = gss_release_cred(&min_stat, &lnd->lnd_cred);
371 if (maj_stat != GSS_S_COMPLETE)
372 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
373 "can't release credential");
378 int error_kernel_key(key_serial_t keyid, int rpc_error, int gss_error)
384 logmsg(LL_TRACE, "revoking kernel key %08x\n", keyid);
387 end = buf + sizeof(buf);
389 WRITE_BYTES(&p, end, seqwin);
390 WRITE_BYTES(&p, end, rpc_error);
391 WRITE_BYTES(&p, end, gss_error);
394 if (keyctl_update(keyid, buf, p - buf)) {
395 if (errno != EAGAIN) {
396 logmsg(LL_ERR, "revoke key %08x: %s\n",
397 keyid, strerror(errno));
401 logmsg(LL_WARN, "key %08x: revoking too soon, try again\n",
407 logmsg(LL_INFO, "key %08x: revoked\n", keyid);
412 int update_kernel_key(key_serial_t keyid,
413 struct lgss_nego_data *lnd,
414 gss_buffer_desc *ctx_token)
416 char *buf = NULL, *p = NULL, *end = NULL;
417 unsigned int buf_size = 0;
420 logmsg(LL_TRACE, "updating kernel key %08x\n", keyid);
422 buf_size = sizeof(lnd->lnd_seq_win) +
423 sizeof(lnd->lnd_rmt_ctx.length) + lnd->lnd_rmt_ctx.length +
424 sizeof(ctx_token->length) + ctx_token->length;
425 buf = malloc(buf_size);
427 logmsg(LL_ERR, "key %08x: can't alloc update buf: size %d\n",
433 end = buf + buf_size;
436 if (WRITE_BYTES(&p, end, lnd->lnd_seq_win))
438 if (write_buffer(&p, end, &lnd->lnd_rmt_ctx))
440 if (write_buffer(&p, end, ctx_token))
444 if (keyctl_update(keyid, buf, p - buf)) {
445 if (errno != EAGAIN) {
446 logmsg(LL_ERR, "update key %08x: %s\n",
447 keyid, strerror(errno));
451 logmsg(LL_DEBUG, "key %08x: updating too soon, try again\n",
458 logmsg(LL_DEBUG, "key %08x: updated\n", keyid);
465 * note we inherited assumed authority from parent process
467 static int lgssc_kr_negotiate(key_serial_t keyid, struct lgss_cred *cred,
468 struct keyring_upcall_param *kup)
470 struct lgss_nego_data lnd;
471 gss_buffer_desc token = GSS_C_EMPTY_BUFFER;
475 logmsg(LL_TRACE, "child start on behalf of key %08x: "
476 "cred %p, uid %u, svc %u, nid %Lx, uids: %u:%u/%u:%u\n",
477 keyid, cred, cred->lc_uid, cred->lc_tgt_svc, cred->lc_tgt_nid,
478 kup->kup_uid, kup->kup_gid, kup->kup_fsuid, kup->kup_fsgid);
480 if (lgss_get_service_str(&g_service, kup->kup_svc, kup->kup_nid)) {
481 logmsg(LL_ERR, "key %08x: failed to construct service "
483 error_kernel_key(keyid, -EACCES, 0);
487 if (lgss_using_cred(cred)) {
488 logmsg(LL_ERR, "key %08x: can't using cred\n", keyid);
489 error_kernel_key(keyid, -EACCES, 0);
493 if (lgssc_init_nego_data(&lnd, kup, cred->lc_mech->lmt_mech_n)) {
494 logmsg(LL_ERR, "key %08x: failed to initialize "
495 "negotiation data\n", keyid);
496 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
500 rc = lgssc_negotiation(&lnd);
502 logmsg(LL_ERR, "key %08x: failed to negotiation\n", keyid);
503 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
507 rc = serialize_context_for_kernel(lnd.lnd_ctx, &token, lnd.lnd_mech);
509 logmsg(LL_ERR, "key %08x: failed to export context\n", keyid);
510 error_kernel_key(keyid, rc, lnd.lnd_gss_err);
514 rc = update_kernel_key(keyid, &lnd, &token);
519 logmsg(LL_INFO, "key %08x for user %u is updated OK!\n",
520 keyid, kup->kup_uid);
522 if (token.length != 0)
523 gss_release_buffer(&min_stat, &token);
525 lgssc_fini_nego_data(&lnd);
528 lgss_release_cred(cred);
533 * call out info format: s[:s]...
535 * [1]: mech_name (string)
538 * [4]: flags (chars) FMT: r-root; m-mds
539 * [5]: lustre_svc (uint)
540 * [6]: target_nid (uint64)
541 * [7]: target_uuid (string)
543 static int parse_callout_info(const char *coinfo,
544 struct keyring_upcall_param *uparam)
553 length = strlen(coinfo) + 1;
555 logmsg(LL_ERR, "coinfo too long\n");
558 memcpy(buf, coinfo, length);
560 for (i = 0; i < nargs - 1; i++) {
561 pos = strchr(string, ':');
563 logmsg(LL_ERR, "short of components\n");
573 logmsg(LL_TRACE, "components: %s,%s,%s,%s,%s,%s,%s,%s\n",
574 data[0], data[1], data[2], data[3], data[4], data[5],
577 uparam->kup_secid = strtol(data[0], NULL, 0);
578 strncpy(uparam->kup_mech, data[1], sizeof(uparam->kup_mech));
579 uparam->kup_uid = strtol(data[2], NULL, 0);
580 uparam->kup_gid = strtol(data[3], NULL, 0);
581 if (strchr(data[4], 'r'))
582 uparam->kup_is_root = 1;
583 if (strchr(data[4], 'm'))
584 uparam->kup_is_mds = 1;
585 uparam->kup_svc = strtol(data[5], NULL, 0);
586 uparam->kup_nid = strtoll(data[6], NULL, 0);
587 strncpy(uparam->kup_tgt, data[7], sizeof(uparam->kup_tgt));
589 logmsg(LL_DEBUG, "parse call out info: secid %d, mech %s, ugid %u:%u "
590 "is_root %d, is_mds %d, svc %d, nid 0x%Lx, tgt %s\n",
591 uparam->kup_secid, uparam->kup_mech,
592 uparam->kup_uid, uparam->kup_gid,
593 uparam->kup_is_root, uparam->kup_is_mds, uparam->kup_svc,
594 uparam->kup_nid, uparam->kup_tgt);
598 #define LOG_LEVEL_PATH "/proc/fs/lustre/sptlrpc/gss/lgss_keyring/debug_level"
600 static void set_log_level()
605 file = fopen(LOG_LEVEL_PATH, "r");
609 if (fscanf(file, "%u", &level) != 1)
615 lgss_set_loglevel(level);
620 /****************************************
622 ****************************************/
624 int main(int argc, char *argv[])
626 struct keyring_upcall_param uparam;
629 key_serial_t inst_keyring;
631 struct lgss_mech_type *mech;
632 struct lgss_cred *cred;
636 logmsg(LL_TRACE, "start parsing parameters\n");
638 * parse & sanity check upcall parameters
639 * expected to be called with:
643 * [4]: key description
647 * [8]: thread keyring
648 * [9]: process keyring
649 * [10]: session keyring
651 if (argc != 10 + 1) {
652 logmsg(LL_ERR, "invalid parameter number %d\n", argc);
656 logmsg(LL_INFO, "key %s, desc %s, ugid %s:%s, sring %s, coinfo %s\n",
657 argv[2], argv[4], argv[6], argv[7], argv[10], argv[5]);
659 memset(&uparam, 0, sizeof(uparam));
661 if (strcmp(argv[1], "create") != 0) {
662 logmsg(LL_ERR, "invalid OP %s\n", argv[1]);
666 if (sscanf(argv[2], "%d", &keyid) != 1) {
667 logmsg(LL_ERR, "can't extract KeyID: %s\n", argv[2]);
671 if (sscanf(argv[6], "%d", &uparam.kup_fsuid) != 1) {
672 logmsg(LL_ERR, "can't extract UID: %s\n", argv[6]);
676 if (sscanf(argv[7], "%d", &uparam.kup_fsgid) != 1) {
677 logmsg(LL_ERR, "can't extract GID: %s\n", argv[7]);
681 if (sscanf(argv[10], "%d", &sring) != 1) {
682 logmsg(LL_ERR, "can't extract session keyring: %s\n", argv[10]);
686 if (parse_callout_info(argv[5], &uparam)) {
687 logmsg(LL_ERR, "can't extract callout info: %s\n", argv[5]);
691 logmsg(LL_TRACE, "parsing parameters OK\n");
696 mech = lgss_name2mech(uparam.kup_mech);
698 logmsg(LL_ERR, "key %08x: unsupported mech: %s\n",
699 keyid, uparam.kup_mech);
703 if (lgss_mech_initialize(mech)) {
704 logmsg(LL_ERR, "key %08x: can't initialize mech %s\n",
705 keyid, mech->lmt_name);
709 cred = lgss_create_cred(mech);
711 logmsg(LL_ERR, "key %08x: can't create a new %s cred\n",
712 keyid, mech->lmt_name);
716 cred->lc_uid = uparam.kup_uid;
717 cred->lc_fl_root = (uparam.kup_is_root != 0);
718 cred->lc_fl_mds = (uparam.kup_is_mds != 0);
719 cred->lc_tgt_nid = uparam.kup_nid;
720 cred->lc_tgt_svc = uparam.kup_svc;
722 if (lgss_prepare_cred(cred)) {
723 logmsg(LL_ERR, "key %08x: failed to prepare credentials "
724 "for user %d\n", keyid, uparam.kup_uid);
728 /* pre initialize the key. note the keyring linked to is actually of the
729 * original requesting process, not _this_ upcall process. if it's for
730 * root user, don't link to any keyrings because we want fully control
731 * on it, and share it among all root sessions; otherswise link to
734 if (cred->lc_fl_root || cred->lc_fl_mds)
737 inst_keyring = KEY_SPEC_SESSION_KEYRING;
739 if (keyctl_instantiate(keyid, NULL, 0, inst_keyring)) {
740 logmsg(LL_ERR, "instantiate key %08x: %s\n",
741 keyid, strerror(errno));
745 logmsg(LL_TRACE, "instantiated kernel key %08x\n", keyid);
748 * fork a child to do the real gss negotiation
752 logmsg(LL_ERR, "key %08x: can't create child: %s\n",
753 keyid, strerror(errno));
755 } else if (child == 0) {
756 return lgssc_kr_negotiate(keyid, cred, &uparam);
759 logmsg(LL_TRACE, "forked child %d\n", child);