2 * Modified from NFSv4 project for Lustre
4 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
6 * Copyright (c) 2012, 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 <lustre_sec.h>
19 typedef struct netobj_s {
24 #define NETOBJ_EMPTY ((netobj_t) { 0 })
26 typedef struct rawobj_s {
31 #define RAWOBJ_EMPTY ((rawobj_t) { 0, NULL })
33 typedef struct rawobj_buf_s {
40 int rawobj_empty(rawobj_t *obj);
41 int rawobj_alloc(rawobj_t *obj, char *buf, int len);
42 void rawobj_free(rawobj_t *obj);
43 int rawobj_equal(rawobj_t *a, rawobj_t *b);
44 int rawobj_dup(rawobj_t *dest, rawobj_t *src);
45 int rawobj_serialize(rawobj_t *obj, __u32 **buf, __u32 *buflen);
46 int rawobj_extract(rawobj_t *obj, __u32 **buf, __u32 *buflen);
47 int rawobj_extract_alloc(rawobj_t *obj, __u32 **buf, __u32 *buflen);
48 int rawobj_extract_local(rawobj_t *obj, __u32 **buf, __u32 *buflen);
49 int rawobj_extract_local_alloc(rawobj_t *obj, __u32 **buf, __u32 *buflen);
50 int rawobj_from_netobj(rawobj_t *rawobj, netobj_t *netobj);
51 int rawobj_from_netobj_alloc(rawobj_t *obj, netobj_t *netobj);
53 int buffer_extract_bytes(const void **buf, __u32 *buflen,
54 void *res, __u32 reslen);
57 * several timeout values. client refresh upcall timeout we using
58 * default in pipefs implemnetation.
60 #define __TIMEOUT_DELTA (10)
62 #define GSS_SECINIT_RPC_TIMEOUT \
63 (obd_timeout < __TIMEOUT_DELTA ? \
64 __TIMEOUT_DELTA : obd_timeout - __TIMEOUT_DELTA)
66 #define GSS_SECFINI_RPC_TIMEOUT (__TIMEOUT_DELTA)
67 #define GSS_SECSVC_UPCALL_TIMEOUT (GSS_SECINIT_RPC_TIMEOUT)
72 #define GSS_GC_INTERVAL (60 * 60) /* 60 minutes */
75 unsigned long gss_round_ctx_expiry(unsigned long expiry,
76 unsigned long sec_flags)
78 if (sec_flags & PTLRPC_SEC_FL_REVERSE)
81 if (get_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
95 #define GSSD_INTERFACE_VERSION (1)
97 #define PTLRPC_GSS_VERSION (1)
100 enum ptlrpc_gss_proc {
101 PTLRPC_GSS_PROC_DATA = 0,
102 PTLRPC_GSS_PROC_INIT = 1,
103 PTLRPC_GSS_PROC_CONTINUE_INIT = 2,
104 PTLRPC_GSS_PROC_DESTROY = 3,
105 PTLRPC_GSS_PROC_ERR = 4,
108 enum ptlrpc_gss_tgt {
109 LUSTRE_GSS_TGT_MGS = 0,
110 LUSTRE_GSS_TGT_MDS = 1,
111 LUSTRE_GSS_TGT_OSS = 2,
114 enum ptlrpc_gss_header_flags {
115 LUSTRE_GSS_PACK_BULK = 1,
116 LUSTRE_GSS_PACK_USER = 2,
120 __u32 import_to_gss_svc(struct obd_import *imp)
122 const char *name = imp->imp_obd->obd_type->typ_name;
124 if (!strcmp(name, LUSTRE_MGC_NAME))
125 return LUSTRE_GSS_TGT_MGS;
126 if (!strcmp(name, LUSTRE_MDC_NAME))
127 return LUSTRE_GSS_TGT_MDS;
128 if (!strcmp(name, LUSTRE_OSC_NAME))
129 return LUSTRE_GSS_TGT_OSS;
135 * following 3 header must have the same size and offset
138 __u8 gh_version; /* gss version */
139 __u8 gh_sp; /* sec part */
141 __u32 gh_flags; /* wrap flags */
142 __u32 gh_proc; /* proc */
143 __u32 gh_seq; /* sequence */
144 __u32 gh_svc; /* service */
148 netobj_t gh_handle; /* context handle */
151 struct gss_rep_header {
165 struct gss_err_header {
180 * part of wire context information send from client which be saved and
181 * used later by server.
183 struct gss_wire_ctx {
191 #define PTLRPC_GSS_MAX_HANDLE_SIZE (8)
192 #define PTLRPC_GSS_HEADER_SIZE (sizeof(struct gss_header) + \
193 PTLRPC_GSS_MAX_HANDLE_SIZE)
196 static inline __u64 gss_handle_to_u64(rawobj_t *handle)
198 if (handle->len != PTLRPC_GSS_MAX_HANDLE_SIZE)
200 return *((__u64 *) handle->data);
203 #define GSS_SEQ_WIN (2048)
204 #define GSS_SEQ_WIN_MAIN GSS_SEQ_WIN
205 #define GSS_SEQ_WIN_BACK (128)
206 #define GSS_SEQ_REPACK_THRESHOLD (GSS_SEQ_WIN_MAIN / 2 + \
207 GSS_SEQ_WIN_MAIN / 4)
209 struct gss_svc_seq_data {
212 * highest sequence number seen so far, for main and back window
217 * main and back window
218 * for i such that ssd_max - GSS_SEQ_WIN < i <= ssd_max, the i-th bit
219 * of ssd_win is nonzero iff sequence number i has been seen already.
221 unsigned long ssd_win_main[GSS_SEQ_WIN_MAIN/BITS_PER_LONG];
222 unsigned long ssd_win_back[GSS_SEQ_WIN_BACK/BITS_PER_LONG];
226 struct gss_ctx *gsc_mechctx;
227 struct gss_svc_seq_data gsc_seqdata;
228 rawobj_t gsc_rvs_hdl;
232 uid_t gsc_mapped_uid;
233 unsigned int gsc_usr_root:1,
240 struct gss_svc_reqctx {
241 struct ptlrpc_svc_ctx src_base;
245 struct gss_wire_ctx src_wirectx;
246 struct gss_svc_ctx *src_ctx;
248 * record place of bulk_sec_desc in request/reply buffer
250 struct ptlrpc_bulk_sec_desc *src_reqbsd;
252 struct ptlrpc_bulk_sec_desc *src_repbsd;
257 unsigned int src_init:1,
264 struct ptlrpc_cli_ctx gc_base;
270 struct gss_ctx *gc_mechctx;
271 /* handle for the buddy svc ctx */
272 rawobj_t gc_svc_handle;
275 struct gss_cli_ctx_keyring {
276 struct gss_cli_ctx gck_base;
278 struct timer_list *gck_timer;
282 struct ptlrpc_sec gs_base;
283 struct gss_api_mech *gs_mech;
288 struct gss_sec_pipefs {
289 struct gss_sec gsp_base;
290 int gsp_chash_size; /* must be 2^n */
291 cfs_hlist_head_t gsp_chash[0];
295 * FIXME cleanup the keyring upcall mutexes
297 #define HAVE_KEYRING_UPCALL_SERIALIZED 1
299 struct gss_sec_keyring {
300 struct gss_sec gsk_base;
302 * all contexts listed here. access is protected by sec spinlock.
304 cfs_hlist_head_t gsk_clist;
306 * specially point to root ctx (only one at a time). access is
307 * protected by sec spinlock.
309 struct ptlrpc_cli_ctx *gsk_root_ctx;
311 * specially serialize upcalls for root context.
313 struct mutex gsk_root_uc_lock;
315 #ifdef HAVE_KEYRING_UPCALL_SERIALIZED
316 struct mutex gsk_uc_lock; /* serialize upcalls */
320 static inline struct gss_cli_ctx *ctx2gctx(struct ptlrpc_cli_ctx *ctx)
322 return container_of(ctx, struct gss_cli_ctx, gc_base);
326 struct gss_cli_ctx_keyring *ctx2gctx_keyring(struct ptlrpc_cli_ctx *ctx)
328 return container_of(ctx2gctx(ctx),
329 struct gss_cli_ctx_keyring, gck_base);
332 static inline struct gss_sec *sec2gsec(struct ptlrpc_sec *sec)
334 return container_of(sec, struct gss_sec, gs_base);
337 static inline struct gss_sec_pipefs *sec2gsec_pipefs(struct ptlrpc_sec *sec)
339 return container_of(sec2gsec(sec), struct gss_sec_pipefs, gsp_base);
342 static inline struct gss_sec_keyring *sec2gsec_keyring(struct ptlrpc_sec *sec)
344 return container_of(sec2gsec(sec), struct gss_sec_keyring, gsk_base);
348 #define GSS_CTX_INIT_MAX_LEN (1024)
351 * This only guaranteed be enough for current krb5 des-cbc-crc . We might
352 * adjust this when new enc type or mech added in.
354 #define GSS_PRIVBUF_PREFIX_LEN (32)
355 #define GSS_PRIVBUF_SUFFIX_LEN (32)
358 struct gss_svc_reqctx *gss_svc_ctx2reqctx(struct ptlrpc_svc_ctx *ctx)
361 return container_of(ctx, struct gss_svc_reqctx, src_base);
365 struct gss_svc_ctx *gss_svc_ctx2gssctx(struct ptlrpc_svc_ctx *ctx)
368 return gss_svc_ctx2reqctx(ctx)->src_ctx;
372 int gss_cli_ctx_match(struct ptlrpc_cli_ctx *ctx, struct vfs_cred *vcred);
373 int gss_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
374 int gss_cli_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
375 int gss_cli_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
376 int gss_cli_ctx_seal(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
377 int gss_cli_ctx_unseal(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
379 int gss_sec_install_rctx(struct obd_import *imp, struct ptlrpc_sec *sec,
380 struct ptlrpc_cli_ctx *ctx);
381 int gss_alloc_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
383 void gss_free_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
384 int gss_alloc_repbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
386 void gss_free_repbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
387 int gss_enlarge_reqbuf(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
388 int segment, int newsize);
390 int gss_svc_accept(struct ptlrpc_sec_policy *policy,
391 struct ptlrpc_request *req);
392 void gss_svc_invalidate_ctx(struct ptlrpc_svc_ctx *svc_ctx);
393 int gss_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
394 int gss_svc_authorize(struct ptlrpc_request *req);
395 void gss_svc_free_rs(struct ptlrpc_reply_state *rs);
396 void gss_svc_free_ctx(struct ptlrpc_svc_ctx *ctx);
398 int cli_ctx_expire(struct ptlrpc_cli_ctx *ctx);
399 int cli_ctx_check_death(struct ptlrpc_cli_ctx *ctx);
401 int gss_copy_rvc_cli_ctx(struct ptlrpc_cli_ctx *cli_ctx,
402 struct ptlrpc_svc_ctx *svc_ctx);
404 struct gss_header *gss_swab_header(struct lustre_msg *msg, int segment,
406 netobj_t *gss_swab_netobj(struct lustre_msg *msg, int segment);
408 void gss_cli_ctx_uptodate(struct gss_cli_ctx *gctx);
409 int gss_pack_err_notify(struct ptlrpc_request *req, __u32 major, __u32 minor);
410 int gss_check_seq_num(struct gss_svc_seq_data *sd, __u32 seq_num, int set);
412 int gss_sec_create_common(struct gss_sec *gsec,
413 struct ptlrpc_sec_policy *policy,
414 struct obd_import *imp,
415 struct ptlrpc_svc_ctx *ctx,
416 struct sptlrpc_flavor *sf);
417 void gss_sec_destroy_common(struct gss_sec *gsec);
418 void gss_sec_kill(struct ptlrpc_sec *sec);
420 int gss_cli_ctx_init_common(struct ptlrpc_sec *sec,
421 struct ptlrpc_cli_ctx *ctx,
422 struct ptlrpc_ctx_ops *ctxops,
423 struct vfs_cred *vcred);
424 int gss_cli_ctx_fini_common(struct ptlrpc_sec *sec,
425 struct ptlrpc_cli_ctx *ctx);
427 void gss_cli_ctx_flags2str(unsigned long flags, char *buf, int bufsize);
430 int __init gss_init_keyring(void);
431 void __exit gss_exit_keyring(void);
434 int __init gss_init_pipefs(void);
435 void __exit gss_exit_pipefs(void);
438 int gss_cli_prep_bulk(struct ptlrpc_request *req,
439 struct ptlrpc_bulk_desc *desc);
440 int gss_cli_ctx_wrap_bulk(struct ptlrpc_cli_ctx *ctx,
441 struct ptlrpc_request *req,
442 struct ptlrpc_bulk_desc *desc);
443 int gss_cli_ctx_unwrap_bulk(struct ptlrpc_cli_ctx *ctx,
444 struct ptlrpc_request *req,
445 struct ptlrpc_bulk_desc *desc);
446 int gss_svc_prep_bulk(struct ptlrpc_request *req,
447 struct ptlrpc_bulk_desc *desc);
448 int gss_svc_unwrap_bulk(struct ptlrpc_request *req,
449 struct ptlrpc_bulk_desc *desc);
450 int gss_svc_wrap_bulk(struct ptlrpc_request *req,
451 struct ptlrpc_bulk_desc *desc);
453 /* gss_mech_switch.c */
454 int init_kerberos_module(void);
455 void cleanup_kerberos_module(void);
457 /* gss_generic_token.c */
458 int g_token_size(rawobj_t *mech, unsigned int body_size);
459 void g_make_token_header(rawobj_t *mech, int body_size, unsigned char **buf);
460 __u32 g_verify_token_header(rawobj_t *mech, int *body_size,
461 unsigned char **buf_in, int toksize);
464 /* gss_cli_upcall.c */
465 int gss_do_ctx_init_rpc(char *buffer, unsigned long count);
466 int gss_do_ctx_fini_rpc(struct gss_cli_ctx *gctx);
468 int __init gss_init_cli_upcall(void);
469 void __exit gss_exit_cli_upcall(void);
471 /* gss_svc_upcall.c */
472 __u64 gss_get_next_ctx_index(void);
473 int gss_svc_upcall_install_rvs_ctx(struct obd_import *imp,
474 struct gss_sec *gsec,
475 struct gss_cli_ctx *gctx);
476 int gss_svc_upcall_expire_rvs_ctx(rawobj_t *handle);
477 int gss_svc_upcall_dup_handle(rawobj_t *handle, struct gss_svc_ctx *ctx);
478 int gss_svc_upcall_update_sequence(rawobj_t *handle, __u32 seq);
479 int gss_svc_upcall_handle_init(struct ptlrpc_request *req,
480 struct gss_svc_reqctx *grctx,
481 struct gss_wire_ctx *gw,
482 struct obd_device *target,
486 struct gss_svc_ctx *gss_svc_upcall_get_ctx(struct ptlrpc_request *req,
487 struct gss_wire_ctx *gw);
488 void gss_svc_upcall_put_ctx(struct gss_svc_ctx *ctx);
489 void gss_svc_upcall_destroy_ctx(struct gss_svc_ctx *ctx);
491 int __init gss_init_svc_upcall(void);
492 void __exit gss_exit_svc_upcall(void);
495 void gss_stat_oos_record_cli(int behind);
496 void gss_stat_oos_record_svc(int phase, int replay);
498 int __init gss_init_lproc(void);
499 void __exit gss_exit_lproc(void);
501 /* gss_krb5_mech.c */
502 int __init init_kerberos_module(void);
503 void __exit cleanup_kerberos_module(void);
508 void __dbg_memdump(char *name, void *ptr, int size)
510 char *buf, *p = (char *) ptr;
511 int bufsize = size * 2 + 1, i;
513 OBD_ALLOC(buf, bufsize);
515 CDEBUG(D_ERROR, "DUMP ERROR: can't alloc %d bytes\n", bufsize);
519 for (i = 0; i < size; i++)
520 sprintf(&buf[i+i], "%02x", (__u8) p[i]);
521 buf[size + size] = '\0';
522 LCONSOLE_INFO("DUMP %s@%p(%d): %s\n", name, ptr, size, buf);
523 OBD_FREE(buf, bufsize);
526 #endif /* __PTLRPC_GSS_GSS_INTERNAL_H_ */