1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
5 * user-space upcall to create GSS context, using keyring interface to kernel
7 * Copyright (c) 2007 Cluster File Systems, Inc.
8 * Author: Eric Mei <ericm@clusterfs.com>
10 * This file is part of the Lustre file system, http://www.lustre.org
11 * Lustre is a trademark of Cluster File Systems, Inc.
13 * You may have signed or agreed to another license before downloading
14 * this software. If so, you are bound by the terms and conditions
15 * of that agreement, and the following does not apply to you. See the
16 * LICENSE file included with this distribution for more information.
18 * If you did not agree to a different license, then this copy of Lustre
19 * is open source software; you can redistribute it and/or modify it
20 * under the terms of version 2 of the GNU General Public License as
21 * published by the Free Software Foundation.
23 * In either case, Lustre is distributed in the hope that it will be
24 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
25 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * license text for more details.
37 #include <gssapi/gssapi.h>
40 #include "lgss_utils.h"
41 #include "write_bytes.h"
45 * gss target string of lustre service we are negotiating for
47 static char *g_service = NULL;
50 * all data about negotiation
52 struct lgss_nego_data {
53 uint32_t lnd_established:1;
60 gss_OID lnd_mech; /* mech OID */
61 gss_name_t lnd_svc_name; /* service name */
62 u_int lnd_req_flags; /* request flags */
63 gss_cred_id_t lnd_cred; /* credential */
64 gss_ctx_id_t lnd_ctx; /* session context */
65 gss_buffer_desc lnd_rmt_ctx; /* remote handle of context */
66 uint32_t lnd_seq_win; /* sequence window */
73 * context creation response
75 struct lgss_init_res {
76 gss_buffer_desc gr_ctx; /* context handle */
77 u_int gr_major; /* major status */
78 u_int gr_minor; /* minor status */
79 u_int gr_win; /* sequence window */
80 gss_buffer_desc gr_token; /* token */
83 struct keyring_upcall_param {
98 /****************************************
99 * child process: gss negotiation *
100 ****************************************/
102 #define INIT_CHANNEL "/proc/fs/lustre/sptlrpc/gss/init_channel"
104 int do_nego_rpc(struct lgss_nego_data *lnd,
105 gss_buffer_desc *gss_token,
106 struct lgss_init_res *gr)
108 struct lgssd_ioctl_param param;
114 logmsg(LL_TRACE, "start negotiation rpc\n");
116 pw = getpwuid(lnd->lnd_uid);
118 logmsg(LL_ERR, "no uid %u in local user database\n",
123 param.version = GSSD_INTERFACE_VERSION;
124 param.secid = lnd->lnd_secid;
125 param.uuid = lnd->lnd_uuid;
126 param.lustre_svc = lnd->lnd_lsvc;
127 param.uid = lnd->lnd_uid;
128 param.gid = pw->pw_gid;
129 param.send_token_size = gss_token->length;
130 param.send_token = (char *) gss_token->value;
131 param.reply_buf_size = sizeof(outbuf);
132 param.reply_buf = outbuf;
134 logmsg(LL_TRACE, "to open " INIT_CHANNEL "\n");
136 fd = open(INIT_CHANNEL, O_WRONLY);
138 logmsg(LL_ERR, "can't open " INIT_CHANNEL "\n");
142 logmsg(LL_TRACE, "to down-write\n");
144 ret = write(fd, ¶m, sizeof(param));
145 if (ret != sizeof(param)) {
146 logmsg(LL_ERR, "lustre ioctl err: %d\n", strerror(errno));
152 logmsg(LL_TRACE, "do_nego_rpc: to parse reply\n");
154 logmsg(LL_ERR, "status: %d (%s)\n",
155 param.status, strerror((int)param.status));
157 /* kernel return -ETIMEDOUT means the rpc timedout, we should
158 * notify the caller to reinitiate the gss negotiation, by
159 * returning -ERESTART
161 if (param.status == -ETIMEDOUT)
167 p = (unsigned int *)outbuf;
173 gr->gr_ctx.length = *p++;
174 gr->gr_ctx.value = malloc(gr->gr_ctx.length);
175 memcpy(gr->gr_ctx.value, p, gr->gr_ctx.length);
176 p += (((gr->gr_ctx.length + 3) & ~3) / 4);
178 gr->gr_token.length = *p++;
179 gr->gr_token.value = malloc(gr->gr_token.length);
180 memcpy(gr->gr_token.value, p, gr->gr_token.length);
181 p += (((gr->gr_token.length + 3) & ~3) / 4);
183 logmsg(LL_DEBUG, "do_nego_rpc: receive handle len %d, token len %d\n",
184 gr->gr_ctx.length, gr->gr_token.length);
189 * if return error, the lnd_rpc_err or lnd_gss_err is set.
191 static int lgssc_negotiation(struct lgss_nego_data *lnd)
193 struct lgss_init_res gr;
194 gss_buffer_desc *recv_tokenp, send_token;
195 OM_uint32 maj_stat, min_stat, ret_flags;
197 logmsg(LL_TRACE, "start gss negotiation\n");
199 /* GSS context establishment loop. */
200 memset(&gr, 0, sizeof(gr));
201 recv_tokenp = GSS_C_NO_BUFFER;
204 maj_stat = gss_init_sec_context(&min_stat,
213 NULL, /* used mech */
216 NULL); /* time rec */
218 if (recv_tokenp != GSS_C_NO_BUFFER) {
219 gss_release_buffer(&min_stat, &gr.gr_token);
220 recv_tokenp = GSS_C_NO_BUFFER;
223 if (maj_stat != GSS_S_COMPLETE &&
224 maj_stat != GSS_S_CONTINUE_NEEDED) {
225 lnd->lnd_gss_err = maj_stat;
227 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
228 "failed init context");
232 if (send_token.length != 0) {
233 memset(&gr, 0, sizeof(gr));
235 lnd->lnd_rpc_err = do_nego_rpc(lnd, &send_token, &gr);
236 gss_release_buffer(&min_stat, &send_token);
238 if (lnd->lnd_rpc_err) {
239 logmsg(LL_ERR, "negotiation rpc error: %d\n",
244 if (gr.gr_major != GSS_S_COMPLETE &&
245 gr.gr_major != GSS_S_CONTINUE_NEEDED) {
246 lnd->lnd_gss_err = gr.gr_major;
248 logmsg(LL_ERR, "negotiation gss error %x\n",
253 if (gr.gr_ctx.length != 0) {
254 if (lnd->lnd_rmt_ctx.value)
255 gss_release_buffer(&min_stat,
257 lnd->lnd_rmt_ctx = gr.gr_ctx;
260 if (gr.gr_token.length != 0) {
261 if (maj_stat != GSS_S_CONTINUE_NEEDED)
263 recv_tokenp = &gr.gr_token;
267 /* GSS_S_COMPLETE => check gss header verifier,
268 * usually checked in gss_validate
270 if (maj_stat == GSS_S_COMPLETE) {
271 lnd->lnd_established = 1;
272 lnd->lnd_seq_win = gr.gr_win;
277 /* End context negotiation loop. */
278 if (!lnd->lnd_established) {
279 if (gr.gr_token.length != 0)
280 gss_release_buffer(&min_stat, &gr.gr_token);
282 if (lnd->lnd_gss_err == GSS_S_COMPLETE)
283 lnd->lnd_rpc_err = -EACCES;
285 logmsg(LL_ERR, "context negotiation failed\n");
289 logmsg(LL_DEBUG, "successfully negotiated a context\n");
294 * if return error, the lnd_rpc_err or lnd_gss_err is set.
296 static int lgssc_init_nego_data(struct lgss_nego_data *lnd,
297 struct keyring_upcall_param *kup,
300 gss_buffer_desc sname;
301 OM_uint32 maj_stat, min_stat;
303 memset(lnd, 0, sizeof(*lnd));
305 lnd->lnd_secid = kup->kup_secid;
306 lnd->lnd_uid = kup->kup_uid;
307 lnd->lnd_lsvc = kup->kup_svc;
308 lnd->lnd_uuid = kup->kup_tgt;
310 lnd->lnd_established = 0;
311 lnd->lnd_svc_name = GSS_C_NO_NAME;
312 lnd->lnd_cred = GSS_C_NO_CREDENTIAL;
313 lnd->lnd_ctx = GSS_C_NO_CONTEXT;
314 lnd->lnd_rmt_ctx = (gss_buffer_desc) GSS_C_EMPTY_BUFFER;
315 lnd->lnd_seq_win = 0;
319 lnd->lnd_mech = (gss_OID) &krb5oid;
320 lnd->lnd_req_flags = GSS_C_MUTUAL_FLAG;
323 logmsg(LL_ERR, "invalid mech: %d\n", mech);
324 lnd->lnd_rpc_err = -EACCES;
328 sname.value = g_service;
329 sname.length = strlen(g_service);
331 maj_stat = gss_import_name(&min_stat, &sname,
332 (gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
334 if (maj_stat != GSS_S_COMPLETE) {
335 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
336 "can't import svc name");
337 lnd->lnd_gss_err = maj_stat;
344 void lgssc_fini_nego_data(struct lgss_nego_data *lnd)
346 OM_uint32 maj_stat, min_stat;
348 if (lnd->lnd_svc_name != GSS_C_NO_NAME) {
349 maj_stat = gss_release_name(&min_stat, &lnd->lnd_svc_name);
350 if (maj_stat != GSS_S_COMPLETE)
351 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
352 "can't release service name");
355 if (lnd->lnd_cred != GSS_C_NO_CREDENTIAL) {
356 maj_stat = gss_release_cred(&min_stat, &lnd->lnd_cred);
357 if (maj_stat != GSS_S_COMPLETE)
358 logmsg_gss(LL_ERR, lnd->lnd_mech, maj_stat, min_stat,
359 "can't release credential");
364 int error_kernel_key(key_serial_t keyid, int rpc_error, int gss_error)
370 logmsg(LL_TRACE, "revoking kernel key %08x\n", keyid);
373 end = buf + sizeof(buf);
375 WRITE_BYTES(&p, end, seqwin);
376 WRITE_BYTES(&p, end, rpc_error);
377 WRITE_BYTES(&p, end, gss_error);
380 if (keyctl_update(keyid, buf, p - buf)) {
381 if (errno != EAGAIN) {
382 logmsg(LL_ERR, "revoke key %08x: %s\n",
383 keyid, strerror(errno));
387 logmsg(LL_WARN, "key %08x: revoking too soon, try again\n",
393 logmsg(LL_INFO, "key %08x: revoked\n", keyid);
398 int update_kernel_key(key_serial_t keyid,
399 struct lgss_nego_data *lnd,
400 gss_buffer_desc *ctx_token)
402 char *buf = NULL, *p = NULL, *end = NULL;
403 unsigned int buf_size = 0;
406 logmsg(LL_TRACE, "updating kernel key %08x\n", keyid);
408 buf_size = sizeof(lnd->lnd_seq_win) +
409 sizeof(lnd->lnd_rmt_ctx.length) + lnd->lnd_rmt_ctx.length +
410 sizeof(ctx_token->length) + ctx_token->length;
411 buf = malloc(buf_size);
413 logmsg(LL_ERR, "key %08x: can't alloc update buf: size %d\n",
419 end = buf + buf_size;
422 if (WRITE_BYTES(&p, end, lnd->lnd_seq_win))
424 if (write_buffer(&p, end, &lnd->lnd_rmt_ctx))
426 if (write_buffer(&p, end, ctx_token))
430 if (keyctl_update(keyid, buf, p - buf)) {
431 if (errno != EAGAIN) {
432 logmsg(LL_ERR, "update key %08x: %s\n",
433 keyid, strerror(errno));
437 logmsg(LL_DEBUG, "key %08x: updating too soon, try again\n",
444 logmsg(LL_DEBUG, "key %08x: updated\n", keyid);
451 * note we inherited assumed authority from parent process
453 static int lgssc_kr_negotiate(key_serial_t keyid, struct lgss_cred *cred,
454 struct keyring_upcall_param *kup)
456 struct lgss_nego_data lnd;
457 gss_buffer_desc token = GSS_C_EMPTY_BUFFER;
461 logmsg(LL_TRACE, "child start on behalf of key %08x: "
462 "cred %p, uid %u, svc %u, nid %Lx, uids: %u:%u/%u:%u\n",
463 keyid, cred, cred->lc_uid, cred->lc_tgt_svc, cred->lc_tgt_nid,
464 kup->kup_uid, kup->kup_gid, kup->kup_fsuid, kup->kup_fsgid);
466 if (lgss_get_service_str(&g_service, kup->kup_svc, kup->kup_nid)) {
467 logmsg(LL_ERR, "key %08x: failed to construct service "
469 error_kernel_key(keyid, -EACCES, 0);
473 if (lgss_using_cred(cred)) {
474 logmsg(LL_ERR, "key %08x: can't using cred\n", keyid);
475 error_kernel_key(keyid, -EACCES, 0);
479 if (lgssc_init_nego_data(&lnd, kup, cred->lc_mech->lmt_mech_n)) {
480 logmsg(LL_ERR, "key %08x: failed to initialize "
481 "negotiation data\n", keyid);
482 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
486 rc = lgssc_negotiation(&lnd);
488 logmsg(LL_ERR, "key %08x: failed to negotiation\n", keyid);
489 error_kernel_key(keyid, lnd.lnd_rpc_err, lnd.lnd_gss_err);
493 rc = serialize_context_for_kernel(lnd.lnd_ctx, &token, lnd.lnd_mech);
495 logmsg(LL_ERR, "key %08x: failed to export context\n", keyid);
496 error_kernel_key(keyid, rc, lnd.lnd_gss_err);
500 rc = update_kernel_key(keyid, &lnd, &token);
505 logmsg(LL_INFO, "key %08x for user %u is updated OK!\n",
506 keyid, kup->kup_uid);
508 if (token.length != 0)
509 gss_release_buffer(&min_stat, &token);
511 lgssc_fini_nego_data(&lnd);
514 lgss_release_cred(cred);
519 * call out info format: s[:s]...
521 * [1]: mech_name (string)
524 * [4]: flags (chars) FMT: r-root; m-mds
525 * [5]: lustre_svc (uint)
526 * [6]: target_nid (uint64)
527 * [7]: target_uuid (string)
529 static int parse_callout_info(const char *coinfo,
530 struct keyring_upcall_param *uparam)
539 length = strlen(coinfo) + 1;
541 logmsg(LL_ERR, "coinfo too long\n");
544 memcpy(buf, coinfo, length);
546 for (i = 0; i < nargs - 1; i++) {
547 pos = strchr(string, ':');
549 logmsg(LL_ERR, "short of components\n");
559 logmsg(LL_TRACE, "components: %s,%s,%s,%s,%s,%s,%s,%s\n",
560 data[0], data[1], data[2], data[3], data[4], data[5],
563 uparam->kup_secid = strtol(data[0], NULL, 0);
564 strncpy(uparam->kup_mech, data[1], sizeof(uparam->kup_mech));
565 uparam->kup_uid = strtol(data[2], NULL, 0);
566 uparam->kup_gid = strtol(data[3], NULL, 0);
567 if (strchr(data[4], 'r'))
568 uparam->kup_is_root = 1;
569 if (strchr(data[4], 'm'))
570 uparam->kup_is_mds = 1;
571 uparam->kup_svc = strtol(data[5], NULL, 0);
572 uparam->kup_nid = strtoll(data[6], NULL, 0);
573 strncpy(uparam->kup_tgt, data[7], sizeof(uparam->kup_tgt));
575 logmsg(LL_DEBUG, "parse call out info: secid %d, mech %s, ugid %u:%u "
576 "is_root %d, is_mds %d, svc %d, nid 0x%Lx, tgt %s\n",
577 uparam->kup_secid, uparam->kup_mech,
578 uparam->kup_uid, uparam->kup_gid,
579 uparam->kup_is_root, uparam->kup_is_mds, uparam->kup_svc,
580 uparam->kup_nid, uparam->kup_tgt);
584 /****************************************
586 ****************************************/
588 int main(int argc, char *argv[])
590 struct keyring_upcall_param uparam;
593 key_serial_t inst_keyring;
595 struct lgss_mech_type *mech;
596 struct lgss_cred *cred;
599 * parse & sanity check upcall parameters
600 * expected to be called with:
604 * [4]: key description
608 * [8]: thread keyring
609 * [9]: process keyring
610 * [10]: session keyring
612 if (argc != 10 + 1) {
613 logmsg(LL_ERR, "invalid parameter number %d\n", argc);
617 logmsg(LL_INFO, "key %s, desc %s, ugid %s:%s, sring %s, coinfo %s\n",
618 argv[2], argv[4], argv[6], argv[7], argv[10], argv[5]);
620 memset(&uparam, 0, sizeof(uparam));
622 if (strcmp(argv[1], "create") != 0) {
623 logmsg(LL_ERR, "invalid OP %s\n", argv[1]);
627 if (sscanf(argv[2], "%d", &keyid) != 1) {
628 logmsg(LL_ERR, "can't extract KeyID: %s\n", argv[2]);
632 if (sscanf(argv[6], "%d", &uparam.kup_fsuid) != 1) {
633 logmsg(LL_ERR, "can't extract UID: %s\n", argv[6]);
637 if (sscanf(argv[7], "%d", &uparam.kup_fsgid) != 1) {
638 logmsg(LL_ERR, "can't extract GID: %s\n", argv[7]);
642 if (sscanf(argv[10], "%d", &sring) != 1) {
643 logmsg(LL_ERR, "can't extract session keyring: %s\n", argv[10]);
647 if (parse_callout_info(argv[5], &uparam)) {
648 logmsg(LL_ERR, "can't extract callout info: %s\n", argv[5]);
652 logmsg(LL_TRACE, "parsing parameters OK\n");
657 mech = lgss_name2mech(uparam.kup_mech);
659 logmsg(LL_ERR, "key %08x: unsupported mech: %s\n",
660 keyid, uparam.kup_mech);
664 if (lgss_mech_initialize(mech)) {
665 logmsg(LL_ERR, "key %08x: can't initialize mech %s\n",
666 keyid, mech->lmt_name);
670 cred = lgss_create_cred(mech);
672 logmsg(LL_ERR, "key %08x: can't create a new %s cred\n",
673 keyid, mech->lmt_name);
677 cred->lc_uid = uparam.kup_uid;
678 cred->lc_fl_root = (uparam.kup_is_root != 0);
679 cred->lc_fl_mds = (uparam.kup_is_mds != 0);
680 cred->lc_tgt_nid = uparam.kup_nid;
681 cred->lc_tgt_svc = uparam.kup_svc;
683 if (lgss_prepare_cred(cred)) {
684 logmsg(LL_ERR, "key %08x: failed to prepare credentials "
685 "for user %d\n", keyid, uparam.kup_uid);
689 /* pre initialize the key. note the keyring linked to is actually of the
690 * original requesting process, not _this_ upcall process. if it's for
691 * root user, don't link to any keyrings because we want fully control
692 * on it, and share it among all root sessions; otherswise link to
695 if (cred->lc_fl_root || cred->lc_fl_mds)
698 inst_keyring = KEY_SPEC_SESSION_KEYRING;
700 if (keyctl_instantiate(keyid, NULL, 0, inst_keyring)) {
701 logmsg(LL_ERR, "instantiate key %08x: %s\n",
702 keyid, strerror(errno));
706 logmsg(LL_TRACE, "instantiated kernel key %08x\n", keyid);
709 * fork a child to do the real gss negotiation
713 logmsg(LL_ERR, "key %08x: can't create child: %s\n",
714 keyid, strerror(errno));
716 } else if (child == 0) {
717 return lgssc_kr_negotiate(keyid, cred, &uparam);
720 logmsg(LL_TRACE, "forked child %d\n", child);