1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/smfs/audit_mds.c
5 * Lustre filesystem audit part for MDS
7 * Copyright (C) 2004 Cluster File Systems, Inc.
9 * This file is part of Lustre, http://www.lustre.org.
11 * Lustre is free software; you can redistribute it and/or
12 * modify it under the terms of version 2 of the GNU General Public
13 * License as published by the Free Software Foundation.
15 * Lustre is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with Lustre; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 # define EXPORT_SYMTAB
28 #define DEBUG_SUBSYSTEM S_SM
30 #include <linux/kmod.h>
31 #include <linux/init.h>
33 #include <linux/slab.h>
34 #include <linux/obd_class.h>
35 #include <linux/obd_support.h>
36 #include <linux/lustre_lib.h>
37 #include <linux/lustre_idl.h>
38 #include <linux/lustre_fsfilt.h>
39 #include <linux/lustre_smfs.h>
40 #include <linux/lustre_audit.h>
41 #include <linux/lustre_log.h>
42 #include "smfs_internal.h"
44 static audit_op hook2audit(hook_op hook)
46 audit_op opcode = AUDIT_NONE;
64 return AUDIT_READLINK;
91 struct inode * get_inode_from_hook(hook_op hook, void * msg)
99 struct hook_link_msg * m = msg;
100 inode = m->dentry->d_inode;
106 struct hook_unlink_msg * m = msg;
107 inode = m->dentry->d_inode;
112 struct hook_symlink_msg * m = msg;
113 inode = m->dentry->d_inode;
118 struct hook_rename_msg * m = msg;
119 inode = m->dentry->d_inode;
128 /* is called also from fsfilt_smfs_get_info */
129 int smfs_get_audit(struct super_block * sb, struct inode * parent,
130 struct inode * inode, __u64 * mask)
132 struct smfs_super_info * smb = S2SMI(sb);
133 struct fsfilt_operations *fsfilt = smb->sm_fsfilt;
134 struct obd_device * obd = smb->smsi_exp->exp_obd;
136 struct audit_priv * priv = NULL;
140 if (!SMFS_IS(smb->plg_flags, SMFS_PLG_AUDIT))
143 priv = smfs_get_plg_priv(S2SMI(sb), SMFS_PLG_AUDIT);
145 /* omit __iopen__ dir */
146 if (parent->i_ino == SMFS_IOPEN_INO)
152 if (IS_AUDIT(priv->a_mask)) {
153 /* no audit for directories on OSS */
154 if (inode && S_ISDIR(inode->i_mode) &&
155 !strcmp(obd->obd_type->typ_name, OBD_FILTER_DEVICENAME))
157 (*mask) = priv->a_mask;
160 /* get inode audit EA */
161 rc = fsfilt->fs_get_xattr(parent, AUDIT_ATTR_EA,
162 mask, sizeof(*mask));
166 /* check if parent has audit */
173 rc = fsfilt->fs_get_xattr(inode, AUDIT_ATTR_EA,
174 mask, sizeof(*mask));
184 int smfs_audit_check(struct inode * parent, hook_op hook, int ret,
185 struct audit_priv * priv, void * msg)
193 if (hook == HOOK_SPECIAL) {
194 struct audit_info * info = msg;
198 code = hook2audit(hook);
200 rc = smfs_get_audit(parent->i_sb, parent,
201 get_inode_from_hook(hook, msg),
205 //should only failures be audited?
206 if (ret >= 0 && IS_AUDIT_OP(mask, AUDIT_FAIL))
210 RETURN(IS_AUDIT_OP(mask, code));
213 static int smfs_set_fs_audit (struct super_block * sb, __u64 *mask)
215 struct smfs_super_info * smb = S2SMI(sb);
216 struct fsfilt_operations * fsfilt = smb->sm_fsfilt;
219 struct file * f = NULL;
220 struct audit_priv *priv;
221 struct lvfs_run_ctxt * ctxt, saved;
224 ctxt = &smb->smsi_exp->exp_obd->obd_lvfs_ctxt;
226 priv = smfs_get_plg_priv(smb, SMFS_PLG_AUDIT);
228 CERROR("Audit is not initialized, use mountoptions 'audit'\n");
232 push_ctxt(&saved, ctxt, NULL);
234 f = filp_open(AUDIT_ATTR_FILE, O_RDWR|O_CREAT, 0600);
236 CERROR("cannot get audit_setting file\n");
241 rc = fsfilt->fs_write_record(f, mask, sizeof(*mask), &off, 1);
243 CERROR("error writting audit setting: rc = %d\n", rc);
247 priv->a_mask = (*mask);
253 pop_ctxt(&saved, ctxt, NULL);
258 //set audit attributes for directory/file
259 int smfs_set_audit(struct super_block * sb, struct inode * inode,
262 void * handle = NULL;
263 struct fsfilt_operations * fsfilt = S2SMI(sb)->sm_fsfilt;
268 if (IS_AUDIT_OP((*mask), AUDIT_FS))
269 return smfs_set_fs_audit(sb, mask);
273 handle = fsfilt->fs_start(inode, FSFILT_OP_SETATTR, NULL, 0);
275 RETURN(PTR_ERR(handle));
277 if (fsfilt->fs_set_xattr)
278 rc = fsfilt->fs_set_xattr(inode, handle, AUDIT_ATTR_EA,
279 mask, sizeof(*mask));
281 fsfilt->fs_commit(inode->i_sb, inode, handle, 1);
286 static int smfs_audit_post_op(hook_op code, struct inode * inode, void * msg,
290 char * buffer = NULL;
291 struct audit_record * rec = NULL;
292 struct llog_rec_hdr * llh;
293 struct timeval cur_time;
294 struct audit_priv * priv = arg;
295 audit_get_op * handler = priv->audit_get_record;
297 //check that we are in lustre ctxt
298 if (!SMFS_IS(I2SMI(inode)->smi_flags, SMFS_PLG_AUDIT))
301 if (!handler || !handler[code])
304 if (smfs_audit_check(inode, code, ret, priv, msg) == 0)
309 do_gettimeofday(&cur_time);
311 OBD_ALLOC(buffer, PAGE_SIZE);
317 rec = (void*)(buffer + sizeof(*llh));
320 rec->uid = current->uid;
321 rec->gid = current->gid;
322 rec->nid = current->user->nid;
323 rec->time = cur_time.tv_sec * USEC_PER_SEC + cur_time.tv_usec;
325 len = handler[code](inode, msg, priv, (char*)rec,
328 LASSERT(llh->lrh_type == SMFS_AUDIT_GEN_REC ||
329 llh->lrh_type == SMFS_AUDIT_NAME_REC);
331 llh->lrh_len = size_round(len);
333 rc = llog_cat_add_rec(priv->audit_ctxt->loc_handle, llh, NULL,
334 (void*)rec, NULL, NULL);
336 CERROR("Error adding audit record: %d\n", rc);
339 audit_notify(priv->audit_ctxt->loc_handle, priv->au_id2name);
342 OBD_FREE(buffer, PAGE_SIZE);
348 static int smfs_trans_audit (struct super_block *sb, void *arg,
349 struct audit_priv * priv)
351 int size = 1; //one record in log per operation.
356 extern int mds_alloc_inode_ids(struct obd_device *, struct inode *,
357 void *, struct lustre_id *, struct lustre_id *);
359 static int smfs_start_audit(struct super_block *sb, void *arg,
360 struct audit_priv * audit_p)
362 struct smfs_super_info * smb = S2SMI(sb);
363 struct fsfilt_operations * fsfilt = smb->sm_fsfilt;
364 struct obd_device *obd = arg;
370 //is plugin already activated
371 if (SMFS_IS(smb->plg_flags, SMFS_PLG_AUDIT))
374 rc = audit_start_transferd();
376 CERROR("can't start audit transfer daemon. rc:%d\n", rc);
380 if (obd && obd->obd_type && obd->obd_type->typ_name) {
381 if (!strcmp(obd->obd_type->typ_name, "mds")) {
382 CDEBUG(D_INODE, "Setup MDS audit handler\n");
383 audit_mds_setup(obd, sb, audit_p);
385 else if (!strcmp(obd->obd_type->typ_name, "obdfilter")) {
386 CDEBUG(D_INODE, "Setup OST audit handler\n");
387 audit_ost_setup(obd, sb, audit_p);
390 CDEBUG(D_INODE, "Unknown obd type %s\n",
391 obd->obd_type->typ_name);
395 //read fs audit settings if any
396 audit_p->a_mask = AUDIT_OFF;
398 f = filp_open(AUDIT_ATTR_FILE, O_RDONLY, 0644);
401 rc = fsfilt->fs_read_record(f, &audit_p->a_mask,
402 sizeof(audit_p->a_mask), &off);
404 CERROR("error reading audit setting: rc = %d\n", rc);
409 SMFS_SET(smb->plg_flags, SMFS_PLG_AUDIT);
414 int smfs_stop_audit(struct super_block *sb, void *arg,
415 struct audit_priv * audit_p)
417 struct smfs_super_info * smb = S2SMI(sb);
418 struct llog_ctxt *ctxt = audit_p->audit_ctxt;
421 if (!SMFS_IS(smb->plg_flags, SMFS_PLG_AUDIT))
424 audit_stop_transferd();
426 SMFS_CLEAR(smb->plg_flags, SMFS_PLG_AUDIT);
429 ctxt->loc_llogs->llog_ctxt[LLOG_AUDIT_ORIG_CTXT] = NULL;
431 llog_catalog_cleanup(ctxt);
432 OBD_FREE(ctxt, sizeof(*ctxt));
433 audit_p->audit_ctxt = NULL;
438 int smfs_audit_set_info(struct super_block *sb, void *arg,
439 struct audit_priv *priv) {
440 struct plg_info_msg * msg = arg;
441 if (KEY_IS(msg->key, "id2name")) {
442 priv->au_id2name = msg->val;
448 typedef int (*audit_helper)(struct super_block * sb, void *msg, struct audit_priv *);
449 static audit_helper smfs_audit_helpers[PLG_HELPER_MAX] = {
450 [PLG_START] smfs_start_audit,
451 [PLG_STOP] smfs_stop_audit,
452 [PLG_TRANS_SIZE] smfs_trans_audit,
453 [PLG_TEST_INODE] NULL,
454 [PLG_SET_INODE] NULL,
455 [PLG_SET_INFO] smfs_audit_set_info,
458 static int smfs_audit_help_op(int code, struct super_block * sb,
459 void * arg, void * priv)
463 if (smfs_audit_helpers[code])
464 rc = smfs_audit_helpers[code](sb, arg, (struct audit_priv *) priv);
468 static int smfs_exit_audit(struct super_block *sb,
471 struct audit_priv * priv = arg;
472 struct smfs_plugin * plg;
475 plg = smfs_deregister_plugin(sb, SMFS_PLG_AUDIT);
477 OBD_FREE(plg, sizeof(*plg));
479 CERROR("Cannot find AUDIT plugin while unregistering\n");
482 OBD_FREE(priv, sizeof(*priv));
487 int smfs_init_audit(struct super_block *sb)
490 struct audit_priv * priv = NULL;
491 struct smfs_plugin * plg = NULL;
495 OBD_ALLOC(plg, sizeof(*plg));
501 plg->plg_type = SMFS_PLG_AUDIT;
502 plg->plg_post_op = &smfs_audit_post_op;
503 plg->plg_helper = &smfs_audit_help_op;
504 plg->plg_exit = &smfs_exit_audit;
506 OBD_ALLOC(priv, sizeof(*priv));
512 plg->plg_private = priv;
513 rc = smfs_register_plugin(sb, plg);
518 OBD_FREE(priv, sizeof(*priv));
521 OBD_FREE(plg, sizeof(*plg));
527 int audit_client_log(struct super_block * sb, struct audit_msg * msg)
529 struct smfs_super_info * smb = S2SMI(sb);
530 char *buffer = NULL, *pbuf = NULL;
531 struct audit_record * rec = NULL;
532 struct llog_rec_hdr * llh;
533 struct llog_handle * ll_handle = NULL;
535 struct timeval cur_time;
537 struct audit_priv * priv;
541 do_gettimeofday(&cur_time);
543 priv = smfs_get_plg_priv(smb, SMFS_PLG_AUDIT);
547 ll_handle = priv->audit_ctxt->loc_handle;
549 OBD_ALLOC(buffer, PAGE_SIZE);
554 llh->lrh_type = SMFS_AUDIT_GEN_REC;
557 rec = (void*)buffer + sizeof(*llh);
558 rec->opcode = msg->code;
559 rec->result = msg->result;
563 rec->time = cur_time.tv_sec * USEC_PER_SEC + cur_time.tv_usec;
565 pbuf = (char*)rec + len;
567 CDEBUG(D_VFSTRACE, "AUDITLOG:"DLID4"\n", OLID4(&msg->id));
568 /* check id is valid */
569 LASSERT(id_ino(&msg->id));
570 LASSERT(id_fid(&msg->id));
571 LASSERT(id_type(&msg->id) & S_IFMT);
579 len += audit_rec_from_id(&pbuf, &msg->id);
582 CERROR("Unknown code %i in audit_msg\n", msg->code);
585 llh->lrh_len = size_round(len);
587 rc = llog_cat_add_rec(ll_handle, llh, NULL, (void*)rec, NULL, NULL);
589 CERROR("Error adding audit client record: %d\n", rc);
592 audit_notify(ll_handle, priv->au_id2name);
595 OBD_FREE(buffer, PAGE_SIZE);