blob: 16622aef9bdea83bee67e5e0080c7b9a17d240ae [file] [log] [blame]
Greg KHb67dbf92005-07-07 14:37:53 -07001/*
2 * inode.c - securityfs
3 *
4 * Copyright (C) 2005 Greg Kroah-Hartman <gregkh@suse.de>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
9 *
10 * Based on fs/debugfs/inode.c which had the following copyright notice:
11 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
12 * Copyright (C) 2004 IBM Inc.
13 */
14
15/* #define DEBUG */
Greg KHb67dbf92005-07-07 14:37:53 -070016#include <linux/module.h>
17#include <linux/fs.h>
18#include <linux/mount.h>
19#include <linux/pagemap.h>
20#include <linux/init.h>
21#include <linux/namei.h>
22#include <linux/security.h>
Mimi Zohar92562922008-10-07 14:00:12 -040023#include <linux/magic.h>
Greg KHb67dbf92005-07-07 14:37:53 -070024
25static struct vfsmount *mount;
26static int mount_count;
27
Greg KHb67dbf92005-07-07 14:37:53 -070028static int fill_super(struct super_block *sb, void *data, int silent)
29{
30 static struct tree_descr files[] = {{""}};
31
32 return simple_fill_super(sb, SECURITYFS_MAGIC, files);
33}
34
Al Virofc14f2f2010-07-25 01:48:30 +040035static struct dentry *get_sb(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -070036 int flags, const char *dev_name,
Al Virofc14f2f2010-07-25 01:48:30 +040037 void *data)
Greg KHb67dbf92005-07-07 14:37:53 -070038{
Al Virofc14f2f2010-07-25 01:48:30 +040039 return mount_single(fs_type, flags, data, fill_super);
Greg KHb67dbf92005-07-07 14:37:53 -070040}
41
42static struct file_system_type fs_type = {
43 .owner = THIS_MODULE,
44 .name = "securityfs",
Al Virofc14f2f2010-07-25 01:48:30 +040045 .mount = get_sb,
Greg KHb67dbf92005-07-07 14:37:53 -070046 .kill_sb = kill_litter_super,
47};
48
Greg KHb67dbf92005-07-07 14:37:53 -070049/**
50 * securityfs_create_file - create a file in the securityfs filesystem
51 *
52 * @name: a pointer to a string containing the name of the file to create.
53 * @mode: the permission that the file should have
54 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap3f23d812008-08-17 21:44:22 -070055 * directory dentry if set. If this parameter is %NULL, then the
Greg KHb67dbf92005-07-07 14:37:53 -070056 * file will be created in the root of the securityfs filesystem.
57 * @data: a pointer to something that the caller will want to get to later
Theodore Ts'o8e18e292006-09-27 01:50:46 -070058 * on. The inode.i_private pointer will point to this value on
Greg KHb67dbf92005-07-07 14:37:53 -070059 * the open() call.
60 * @fops: a pointer to a struct file_operations that should be used for
61 * this file.
62 *
63 * This is the basic "create a file" function for securityfs. It allows for a
Randy Dunlap3f23d812008-08-17 21:44:22 -070064 * wide range of flexibility in creating a file, or a directory (if you
Greg KHb67dbf92005-07-07 14:37:53 -070065 * want to create a directory, the securityfs_create_dir() function is
Randy Dunlap3f23d812008-08-17 21:44:22 -070066 * recommended to be used instead).
Greg KHb67dbf92005-07-07 14:37:53 -070067 *
Randy Dunlap3f23d812008-08-17 21:44:22 -070068 * This function returns a pointer to a dentry if it succeeds. This
Greg KHb67dbf92005-07-07 14:37:53 -070069 * pointer must be passed to the securityfs_remove() function when the file is
70 * to be removed (no automatic cleanup happens if your module is unloaded,
Serge E. Hallynfaa3aad2009-02-02 15:07:33 -080071 * you are responsible here). If an error occurs, the function will return
Masanari Iidada3dae52014-09-09 01:27:23 +090072 * the error value (via ERR_PTR).
Greg KHb67dbf92005-07-07 14:37:53 -070073 *
Randy Dunlap3f23d812008-08-17 21:44:22 -070074 * If securityfs is not enabled in the kernel, the value %-ENODEV is
Serge E. Hallynfaa3aad2009-02-02 15:07:33 -080075 * returned.
Greg KHb67dbf92005-07-07 14:37:53 -070076 */
Al Viro52ef0c02011-07-26 04:30:04 -040077struct dentry *securityfs_create_file(const char *name, umode_t mode,
Greg KHb67dbf92005-07-07 14:37:53 -070078 struct dentry *parent, void *data,
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080079 const struct file_operations *fops)
Greg KHb67dbf92005-07-07 14:37:53 -070080{
Al Viro3e25eb92012-01-10 10:20:35 -050081 struct dentry *dentry;
82 int is_dir = S_ISDIR(mode);
83 struct inode *dir, *inode;
Greg KHb67dbf92005-07-07 14:37:53 -070084 int error;
85
Al Viro3e25eb92012-01-10 10:20:35 -050086 if (!is_dir) {
87 BUG_ON(!fops);
88 mode = (mode & S_IALLUGO) | S_IFREG;
89 }
90
Greg KHb67dbf92005-07-07 14:37:53 -070091 pr_debug("securityfs: creating file '%s'\n",name);
92
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -040093 error = simple_pin_fs(&fs_type, &mount, &mount_count);
Al Viro3e25eb92012-01-10 10:20:35 -050094 if (error)
95 return ERR_PTR(error);
Greg KHb67dbf92005-07-07 14:37:53 -070096
Al Viro3e25eb92012-01-10 10:20:35 -050097 if (!parent)
98 parent = mount->mnt_root;
99
David Howellsce0b16d2015-02-19 10:47:02 +0000100 dir = d_inode(parent);
Al Viro3e25eb92012-01-10 10:20:35 -0500101
102 mutex_lock(&dir->i_mutex);
103 dentry = lookup_one_len(name, parent, strlen(name));
104 if (IS_ERR(dentry))
105 goto out;
Greg KHb67dbf92005-07-07 14:37:53 -0700106
David Howellsce0b16d2015-02-19 10:47:02 +0000107 if (d_really_is_positive(dentry)) {
Al Viro3e25eb92012-01-10 10:20:35 -0500108 error = -EEXIST;
109 goto out1;
Greg KHb67dbf92005-07-07 14:37:53 -0700110 }
Al Viro3e25eb92012-01-10 10:20:35 -0500111
112 inode = new_inode(dir->i_sb);
113 if (!inode) {
114 error = -ENOMEM;
115 goto out1;
116 }
117
118 inode->i_ino = get_next_ino();
119 inode->i_mode = mode;
120 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
121 inode->i_private = data;
122 if (is_dir) {
123 inode->i_op = &simple_dir_inode_operations;
124 inode->i_fop = &simple_dir_operations;
125 inc_nlink(inode);
126 inc_nlink(dir);
127 } else {
128 inode->i_fop = fops;
129 }
130 d_instantiate(dentry, inode);
131 dget(dentry);
132 mutex_unlock(&dir->i_mutex);
133 return dentry;
134
135out1:
136 dput(dentry);
137 dentry = ERR_PTR(error);
138out:
139 mutex_unlock(&dir->i_mutex);
140 simple_release_fs(&mount, &mount_count);
Greg KHb67dbf92005-07-07 14:37:53 -0700141 return dentry;
142}
143EXPORT_SYMBOL_GPL(securityfs_create_file);
144
145/**
146 * securityfs_create_dir - create a directory in the securityfs filesystem
147 *
148 * @name: a pointer to a string containing the name of the directory to
149 * create.
150 * @parent: a pointer to the parent dentry for this file. This should be a
Randy Dunlap3f23d812008-08-17 21:44:22 -0700151 * directory dentry if set. If this parameter is %NULL, then the
Greg KHb67dbf92005-07-07 14:37:53 -0700152 * directory will be created in the root of the securityfs filesystem.
153 *
Randy Dunlap3f23d812008-08-17 21:44:22 -0700154 * This function creates a directory in securityfs with the given @name.
Greg KHb67dbf92005-07-07 14:37:53 -0700155 *
Randy Dunlap3f23d812008-08-17 21:44:22 -0700156 * This function returns a pointer to a dentry if it succeeds. This
Greg KHb67dbf92005-07-07 14:37:53 -0700157 * pointer must be passed to the securityfs_remove() function when the file is
158 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap3f23d812008-08-17 21:44:22 -0700159 * you are responsible here). If an error occurs, %NULL will be returned.
Greg KHb67dbf92005-07-07 14:37:53 -0700160 *
Randy Dunlap3f23d812008-08-17 21:44:22 -0700161 * If securityfs is not enabled in the kernel, the value %-ENODEV is
Greg KHb67dbf92005-07-07 14:37:53 -0700162 * returned. It is not wise to check for this value, but rather, check for
Randy Dunlap3f23d812008-08-17 21:44:22 -0700163 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Greg KHb67dbf92005-07-07 14:37:53 -0700164 * code.
165 */
166struct dentry *securityfs_create_dir(const char *name, struct dentry *parent)
167{
168 return securityfs_create_file(name,
169 S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO,
170 parent, NULL, NULL);
171}
172EXPORT_SYMBOL_GPL(securityfs_create_dir);
173
174/**
175 * securityfs_remove - removes a file or directory from the securityfs filesystem
176 *
Randy Dunlap3f23d812008-08-17 21:44:22 -0700177 * @dentry: a pointer to a the dentry of the file or directory to be removed.
Greg KHb67dbf92005-07-07 14:37:53 -0700178 *
179 * This function removes a file or directory in securityfs that was previously
180 * created with a call to another securityfs function (like
181 * securityfs_create_file() or variants thereof.)
182 *
183 * This function is required to be called in order for the file to be
Randy Dunlap3f23d812008-08-17 21:44:22 -0700184 * removed. No automatic cleanup of files will happen when a module is
185 * removed; you are responsible here.
Greg KHb67dbf92005-07-07 14:37:53 -0700186 */
187void securityfs_remove(struct dentry *dentry)
188{
189 struct dentry *parent;
190
Eric Parisd93e4c92009-05-11 20:47:15 -0400191 if (!dentry || IS_ERR(dentry))
Greg KHb67dbf92005-07-07 14:37:53 -0700192 return;
193
194 parent = dentry->d_parent;
David Howellsce0b16d2015-02-19 10:47:02 +0000195 if (!parent || d_really_is_negative(parent))
Greg KHb67dbf92005-07-07 14:37:53 -0700196 return;
197
David Howellsce0b16d2015-02-19 10:47:02 +0000198 mutex_lock(&d_inode(parent)->i_mutex);
Al Virodc3f4192015-05-18 10:10:34 -0400199 if (simple_positive(dentry)) {
200 if (d_is_dir(dentry))
201 simple_rmdir(d_inode(parent), dentry);
202 else
203 simple_unlink(d_inode(parent), dentry);
204 dput(dentry);
Greg KHb67dbf92005-07-07 14:37:53 -0700205 }
David Howellsce0b16d2015-02-19 10:47:02 +0000206 mutex_unlock(&d_inode(parent)->i_mutex);
Greg KHb67dbf92005-07-07 14:37:53 -0700207 simple_release_fs(&mount, &mount_count);
208}
209EXPORT_SYMBOL_GPL(securityfs_remove);
210
Greg KHb67dbf92005-07-07 14:37:53 -0700211static int __init securityfs_init(void)
212{
213 int retval;
214
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500215 retval = sysfs_create_mount_point(kernel_kobj, "security");
216 if (retval)
217 return retval;
Greg KHb67dbf92005-07-07 14:37:53 -0700218
219 retval = register_filesystem(&fs_type);
220 if (retval)
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500221 sysfs_remove_mount_point(kernel_kobj, "security");
Greg KHb67dbf92005-07-07 14:37:53 -0700222 return retval;
223}
224
Greg KHb67dbf92005-07-07 14:37:53 -0700225core_initcall(securityfs_init);
Greg KHb67dbf92005-07-07 14:37:53 -0700226MODULE_LICENSE("GPL");
227