2 * Modified from NFSv4 project for Lustre
4 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
6 * Copyright (c) 2012, 2016, Intel Corporation.
8 * Author: Eric Mei <ericm@clusterfs.com>
11 #ifndef __PTLRPC_GSS_GSS_INTERNAL_H_
12 #define __PTLRPC_GSS_GSS_INTERNAL_H_
14 #include <linux/crypto.h>
15 #include <lustre_sec.h>
20 typedef struct netobj_s {
25 #define NETOBJ_EMPTY ((netobj_t) { 0 })
27 typedef struct rawobj_s {
32 #define RAWOBJ_EMPTY ((rawobj_t) { 0, NULL })
34 typedef struct rawobj_buf_s {
41 int rawobj_empty(rawobj_t *obj);
42 int rawobj_alloc(rawobj_t *obj, char *buf, int len);
43 void rawobj_free(rawobj_t *obj);
44 int rawobj_equal(rawobj_t *a, rawobj_t *b);
45 int rawobj_dup(rawobj_t *dest, rawobj_t *src);
46 int rawobj_serialize(rawobj_t *obj, __u32 **buf, __u32 *buflen);
47 int rawobj_extract(rawobj_t *obj, __u32 **buf, __u32 *buflen);
48 int rawobj_extract_alloc(rawobj_t *obj, __u32 **buf, __u32 *buflen);
49 int rawobj_extract_local(rawobj_t *obj, __u32 **buf, __u32 *buflen);
50 int rawobj_extract_local_alloc(rawobj_t *obj, __u32 **buf, __u32 *buflen);
51 int rawobj_from_netobj(rawobj_t *rawobj, netobj_t *netobj);
52 int rawobj_from_netobj_alloc(rawobj_t *obj, netobj_t *netobj);
54 int buffer_extract_bytes(const void **buf, __u32 *buflen,
55 void *res, __u32 reslen);
58 * several timeout values. client refresh upcall timeout we using
59 * default in pipefs implemnetation.
61 #define __TIMEOUT_DELTA (10)
63 #define GSS_SECINIT_RPC_TIMEOUT \
64 (obd_timeout < __TIMEOUT_DELTA ? \
65 __TIMEOUT_DELTA : obd_timeout - __TIMEOUT_DELTA)
67 #define GSS_SECFINI_RPC_TIMEOUT (__TIMEOUT_DELTA)
68 #define GSS_SECSVC_UPCALL_TIMEOUT (GSS_SECINIT_RPC_TIMEOUT)
73 #define GSS_GC_INTERVAL (60 * 60) /* 60 minutes */
75 static inline time64_t gss_round_ctx_expiry(time64_t expiry,
76 unsigned long sec_flags)
78 if (sec_flags & PTLRPC_SEC_FL_REVERSE)
81 if (ktime_get_real_seconds() + __TIMEOUT_DELTA <= expiry)
82 return expiry - __TIMEOUT_DELTA;
88 * Max encryption element in block cipher algorithms.
90 #define GSS_MAX_CIPHER_BLOCK (16)
93 * XXX make it visible of kernel and lgssd/lsvcgssd
96 GSSD_INTERFACE_VERSION_V1 = 1,
97 GSSD_INTERFACE_VERSION_V2 = 2,
98 GSSD_INTERFACE_VERSION = GSSD_INTERFACE_VERSION_V2,
101 #define PTLRPC_GSS_VERSION (1)
104 enum ptlrpc_gss_proc {
105 PTLRPC_GSS_PROC_DATA = 0,
106 PTLRPC_GSS_PROC_INIT = 1,
107 PTLRPC_GSS_PROC_CONTINUE_INIT = 2,
108 PTLRPC_GSS_PROC_DESTROY = 3,
109 PTLRPC_GSS_PROC_ERR = 4,
112 enum ptlrpc_gss_tgt {
113 LUSTRE_GSS_TGT_MGS = 0,
114 LUSTRE_GSS_TGT_MDS = 1,
115 LUSTRE_GSS_TGT_OSS = 2,
118 enum ptlrpc_gss_header_flags {
119 LUSTRE_GSS_PACK_BULK = 1,
120 LUSTRE_GSS_PACK_USER = 2,
124 __u32 import_to_gss_svc(struct obd_import *imp)
126 int cl_sp_to = LUSTRE_SP_ANY;
129 cl_sp_to = imp->imp_obd->u.cli.cl_sp_to;
133 return LUSTRE_GSS_TGT_MDS;
135 return LUSTRE_GSS_TGT_OSS;
138 return LUSTRE_GSS_TGT_MGS;
147 * following 3 header must have the same size and offset
150 __u8 gh_version; /* gss version */
151 __u8 gh_sp; /* sec part */
153 __u32 gh_flags; /* wrap flags */
154 __u32 gh_proc; /* proc */
155 __u32 gh_seq; /* sequence */
156 __u32 gh_svc; /* service */
160 netobj_t gh_handle; /* context handle */
163 struct gss_rep_header {
177 struct gss_err_header {
192 * part of wire context information send from client which be saved and
193 * used later by server.
195 struct gss_wire_ctx {
203 #define PTLRPC_GSS_MAX_HANDLE_SIZE (8)
204 #define PTLRPC_GSS_HEADER_SIZE (sizeof(struct gss_header) + \
205 PTLRPC_GSS_MAX_HANDLE_SIZE)
208 static inline __u64 gss_handle_to_u64(rawobj_t *handle)
210 if (handle->len != PTLRPC_GSS_MAX_HANDLE_SIZE)
212 return *((__u64 *) handle->data);
215 #define GSS_SEQ_WIN (2048)
216 #define GSS_SEQ_WIN_MAIN GSS_SEQ_WIN
217 #define GSS_SEQ_WIN_BACK (128)
218 #define GSS_SEQ_REPACK_THRESHOLD (GSS_SEQ_WIN_MAIN / 2 + \
219 GSS_SEQ_WIN_MAIN / 4)
221 struct gss_svc_seq_data {
224 * highest sequence number seen so far, for main and back window
229 * main and back window
230 * for i such that ssd_max - GSS_SEQ_WIN < i <= ssd_max, the i-th bit
231 * of ssd_win is nonzero iff sequence number i has been seen already.
233 unsigned long ssd_win_main[GSS_SEQ_WIN_MAIN/BITS_PER_LONG];
234 unsigned long ssd_win_back[GSS_SEQ_WIN_BACK/BITS_PER_LONG];
238 struct gss_ctx *gsc_mechctx;
239 struct gss_svc_seq_data gsc_seqdata;
240 rawobj_t gsc_rvs_hdl;
244 uid_t gsc_mapped_uid;
245 unsigned int gsc_usr_root:1,
252 struct gss_svc_reqctx {
253 struct ptlrpc_svc_ctx src_base;
257 struct gss_wire_ctx src_wirectx;
258 struct gss_svc_ctx *src_ctx;
260 * record place of bulk_sec_desc in request/reply buffer
262 struct ptlrpc_bulk_sec_desc *src_reqbsd;
264 struct ptlrpc_bulk_sec_desc *src_repbsd;
269 unsigned int src_init:1,
276 struct ptlrpc_cli_ctx gc_base;
282 struct gss_ctx *gc_mechctx;
283 /* handle for the buddy svc ctx */
284 rawobj_t gc_svc_handle;
287 struct gss_cli_ctx_keyring {
288 struct gss_cli_ctx gck_base;
290 struct timer_list *gck_timer;
294 struct ptlrpc_sec gs_base;
295 struct gss_api_mech *gs_mech;
300 struct gss_sec_pipefs {
301 struct gss_sec gsp_base;
302 int gsp_chash_size; /* must be 2^n */
303 struct hlist_head gsp_chash[0];
307 * FIXME cleanup the keyring upcall mutexes
309 #define HAVE_KEYRING_UPCALL_SERIALIZED 1
311 struct gss_sec_keyring {
312 struct gss_sec gsk_base;
314 * all contexts listed here. access is protected by sec spinlock.
316 struct hlist_head gsk_clist;
318 * specially point to root ctx (only one at a time). access is
319 * protected by sec spinlock.
321 struct ptlrpc_cli_ctx *gsk_root_ctx;
323 * specially serialize upcalls for root context.
325 struct mutex gsk_root_uc_lock;
327 #ifdef HAVE_KEYRING_UPCALL_SERIALIZED
328 struct mutex gsk_uc_lock; /* serialize upcalls */
332 static inline struct gss_cli_ctx *ctx2gctx(struct ptlrpc_cli_ctx *ctx)
334 return container_of(ctx, struct gss_cli_ctx, gc_base);
338 struct gss_cli_ctx_keyring *ctx2gctx_keyring(struct ptlrpc_cli_ctx *ctx)
340 return container_of(ctx2gctx(ctx),
341 struct gss_cli_ctx_keyring, gck_base);
344 static inline struct gss_sec *sec2gsec(struct ptlrpc_sec *sec)
346 return container_of(sec, struct gss_sec, gs_base);
349 static inline struct gss_sec_pipefs *sec2gsec_pipefs(struct ptlrpc_sec *sec)
351 return container_of(sec2gsec(sec), struct gss_sec_pipefs, gsp_base);
354 static inline struct gss_sec_keyring *sec2gsec_keyring(struct ptlrpc_sec *sec)
356 return container_of(sec2gsec(sec), struct gss_sec_keyring, gsk_base);
360 #define GSS_CTX_INIT_MAX_LEN (1024)
363 * This only guaranteed be enough for current krb5 des-cbc-crc . We might
364 * adjust this when new enc type or mech added in.
366 #define GSS_PRIVBUF_PREFIX_LEN (32)
367 #define GSS_PRIVBUF_SUFFIX_LEN (32)
370 struct gss_svc_reqctx *gss_svc_ctx2reqctx(struct ptlrpc_svc_ctx *ctx)
373 return container_of(ctx, struct gss_svc_reqctx, src_base);
377 struct gss_svc_ctx *gss_svc_ctx2gssctx(struct ptlrpc_svc_ctx *ctx)
380 return gss_svc_ctx2reqctx(ctx)->src_ctx;
384 int gss_cli_ctx_match(struct ptlrpc_cli_ctx *ctx, struct vfs_cred *vcred);
385 int gss_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
386 int gss_cli_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
387 int gss_cli_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
388 int gss_cli_ctx_seal(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
389 int gss_cli_ctx_unseal(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
391 int gss_sec_install_rctx(struct obd_import *imp, struct ptlrpc_sec *sec,
392 struct ptlrpc_cli_ctx *ctx);
393 int gss_alloc_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
395 void gss_free_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
396 int gss_alloc_repbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
398 void gss_free_repbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
399 int gss_enlarge_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
400 int segment, int newsize);
402 int gss_svc_accept(struct ptlrpc_sec_policy *policy,
403 struct ptlrpc_request *req);
404 void gss_svc_invalidate_ctx(struct ptlrpc_svc_ctx *svc_ctx);
405 int gss_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
406 int gss_svc_authorize(struct ptlrpc_request *req);
407 void gss_svc_free_rs(struct ptlrpc_reply_state *rs);
408 void gss_svc_free_ctx(struct ptlrpc_svc_ctx *ctx);
410 int cli_ctx_expire(struct ptlrpc_cli_ctx *ctx);
411 int cli_ctx_check_death(struct ptlrpc_cli_ctx *ctx);
413 int gss_copy_rvc_cli_ctx(struct ptlrpc_cli_ctx *cli_ctx,
414 struct ptlrpc_svc_ctx *svc_ctx);
416 struct gss_header *gss_swab_header(struct lustre_msg *msg, int segment,
418 netobj_t *gss_swab_netobj(struct lustre_msg *msg, int segment);
420 void gss_cli_ctx_uptodate(struct gss_cli_ctx *gctx);
421 int gss_pack_err_notify(struct ptlrpc_request *req, __u32 major, __u32 minor);
422 int gss_check_seq_num(struct gss_svc_seq_data *sd, __u32 seq_num, int set);
424 int gss_sec_create_common(struct gss_sec *gsec,
425 struct ptlrpc_sec_policy *policy,
426 struct obd_import *imp,
427 struct ptlrpc_svc_ctx *ctx,
428 struct sptlrpc_flavor *sf);
429 void gss_sec_destroy_common(struct gss_sec *gsec);
430 void gss_sec_kill(struct ptlrpc_sec *sec);
432 int gss_cli_ctx_init_common(struct ptlrpc_sec *sec,
433 struct ptlrpc_cli_ctx *ctx,
434 struct ptlrpc_ctx_ops *ctxops,
435 struct vfs_cred *vcred);
436 int gss_cli_ctx_fini_common(struct ptlrpc_sec *sec,
437 struct ptlrpc_cli_ctx *ctx);
439 void gss_cli_ctx_flags2str(unsigned long flags, char *buf, int bufsize);
442 #ifndef HAVE_GSS_KEYRING
443 static inline int __init gss_init_keyring(void) { return 0; }
444 static inline void __exit gss_exit_keyring(void) { return; }
446 int __init gss_init_keyring(void);
447 void __exit gss_exit_keyring(void);
451 #ifndef HAVE_GSS_PIPEFS
452 static inline int __init gss_init_pipefs(void) { return 0; }
453 static inline void __exit gss_exit_pipefs(void) { return; }
455 int __init gss_init_pipefs(void);
456 void __exit gss_exit_pipefs(void);
460 int gss_cli_prep_bulk(struct ptlrpc_request *req,
461 struct ptlrpc_bulk_desc *desc);
462 int gss_cli_ctx_wrap_bulk(struct ptlrpc_cli_ctx *ctx,
463 struct ptlrpc_request *req,
464 struct ptlrpc_bulk_desc *desc);
465 int gss_cli_ctx_unwrap_bulk(struct ptlrpc_cli_ctx *ctx,
466 struct ptlrpc_request *req,
467 struct ptlrpc_bulk_desc *desc);
468 int gss_svc_prep_bulk(struct ptlrpc_request *req,
469 struct ptlrpc_bulk_desc *desc);
470 int gss_svc_unwrap_bulk(struct ptlrpc_request *req,
471 struct ptlrpc_bulk_desc *desc);
472 int gss_svc_wrap_bulk(struct ptlrpc_request *req,
473 struct ptlrpc_bulk_desc *desc);
475 /* gss_generic_token.c */
476 int g_token_size(rawobj_t *mech, unsigned int body_size);
477 void g_make_token_header(rawobj_t *mech, int body_size, unsigned char **buf);
478 __u32 g_verify_token_header(rawobj_t *mech, int *body_size,
479 unsigned char **buf_in, int toksize);
482 /* gss_cli_upcall.c */
483 int gss_do_ctx_init_rpc(char __user *buffer, unsigned long count);
484 int gss_do_ctx_fini_rpc(struct gss_cli_ctx *gctx);
486 int __init gss_init_cli_upcall(void);
487 void gss_exit_cli_upcall(void);
489 /* gss_svc_upcall.c */
490 __u64 gss_get_next_ctx_index(void);
491 int gss_svc_upcall_install_rvs_ctx(struct obd_import *imp,
492 struct gss_sec *gsec,
493 struct gss_cli_ctx *gctx);
494 int gss_svc_upcall_expire_rvs_ctx(rawobj_t *handle);
495 int gss_svc_upcall_dup_handle(rawobj_t *handle, struct gss_svc_ctx *ctx);
496 int gss_svc_upcall_update_sequence(rawobj_t *handle, __u32 seq);
497 int gss_svc_upcall_handle_init(struct ptlrpc_request *req,
498 struct gss_svc_reqctx *grctx,
499 struct gss_wire_ctx *gw,
500 struct obd_device *target,
504 struct gss_svc_ctx *gss_svc_upcall_get_ctx(struct ptlrpc_request *req,
505 struct gss_wire_ctx *gw);
506 void gss_svc_upcall_put_ctx(struct gss_svc_ctx *ctx);
507 void gss_svc_upcall_destroy_ctx(struct gss_svc_ctx *ctx);
509 int __init gss_init_svc_upcall(void);
510 void gss_exit_svc_upcall(void);
513 void gss_stat_oos_record_cli(int behind);
514 void gss_stat_oos_record_svc(int phase, int replay);
516 int __init gss_init_lproc(void);
517 void gss_exit_lproc(void);
519 /* gss_null_mech.c */
520 int __init init_null_module(void);
521 void cleanup_null_module(void);
523 /* gss_krb5_mech.c */
524 int __init init_kerberos_module(void);
525 void cleanup_kerberos_module(void);
528 #ifdef HAVE_OPENSSL_SSK
529 int __init init_sk_module(void);
530 void cleanup_sk_module(void);
532 static inline int init_sk_module(void) { return 0; }
533 static inline void cleanup_sk_module(void) { return; }
534 #endif /* HAVE_OPENSSL_SSK */
538 void __dbg_memdump(char *name, void *ptr, int size)
540 char *buf, *p = (char *) ptr;
541 int bufsize = size * 2 + 1, i;
543 OBD_ALLOC(buf, bufsize);
545 CDEBUG(D_ERROR, "DUMP ERROR: can't alloc %d bytes\n", bufsize);
549 for (i = 0; i < size; i++)
550 sprintf(&buf[i+i], "%02x", (__u8) p[i]);
551 buf[size + size] = '\0';
552 LCONSOLE_INFO("DUMP %s@%p(%d): %s\n", name, ptr, size, buf);
553 OBD_FREE(buf, bufsize);
556 #endif /* __PTLRPC_GSS_GSS_INTERNAL_H_ */