securityfs: fix long-broken securityfs_create_file comment
[linux-2.6.git] / security / inode.c
1 /*
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 */
16 #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>
23 #include <linux/magic.h>
24
25 static struct vfsmount *mount;
26 static int mount_count;
27
28 /*
29  * TODO:
30  *   I think I can get rid of these default_file_ops, but not quite sure...
31  */
32 static ssize_t default_read_file(struct file *file, char __user *buf,
33                                  size_t count, loff_t *ppos)
34 {
35         return 0;
36 }
37
38 static ssize_t default_write_file(struct file *file, const char __user *buf,
39                                    size_t count, loff_t *ppos)
40 {
41         return count;
42 }
43
44 static int default_open(struct inode *inode, struct file *file)
45 {
46         if (inode->i_private)
47                 file->private_data = inode->i_private;
48
49         return 0;
50 }
51
52 static const struct file_operations default_file_ops = {
53         .read =         default_read_file,
54         .write =        default_write_file,
55         .open =         default_open,
56 };
57
58 static struct inode *get_inode(struct super_block *sb, int mode, dev_t dev)
59 {
60         struct inode *inode = new_inode(sb);
61
62         if (inode) {
63                 inode->i_mode = mode;
64                 inode->i_uid = 0;
65                 inode->i_gid = 0;
66                 inode->i_blocks = 0;
67                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
68                 switch (mode & S_IFMT) {
69                 default:
70                         init_special_inode(inode, mode, dev);
71                         break;
72                 case S_IFREG:
73                         inode->i_fop = &default_file_ops;
74                         break;
75                 case S_IFDIR:
76                         inode->i_op = &simple_dir_inode_operations;
77                         inode->i_fop = &simple_dir_operations;
78
79                         /* directory inodes start off with i_nlink == 2 (for "." entry) */
80                         inc_nlink(inode);
81                         break;
82                 }
83         }
84         return inode;
85 }
86
87 /* SMP-safe */
88 static int mknod(struct inode *dir, struct dentry *dentry,
89                          int mode, dev_t dev)
90 {
91         struct inode *inode;
92         int error = -EPERM;
93
94         if (dentry->d_inode)
95                 return -EEXIST;
96
97         inode = get_inode(dir->i_sb, mode, dev);
98         if (inode) {
99                 d_instantiate(dentry, inode);
100                 dget(dentry);
101                 error = 0;
102         }
103         return error;
104 }
105
106 static int mkdir(struct inode *dir, struct dentry *dentry, int mode)
107 {
108         int res;
109
110         mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
111         res = mknod(dir, dentry, mode, 0);
112         if (!res)
113                 inc_nlink(dir);
114         return res;
115 }
116
117 static int create(struct inode *dir, struct dentry *dentry, int mode)
118 {
119         mode = (mode & S_IALLUGO) | S_IFREG;
120         return mknod(dir, dentry, mode, 0);
121 }
122
123 static inline int positive(struct dentry *dentry)
124 {
125         return dentry->d_inode && !d_unhashed(dentry);
126 }
127
128 static int fill_super(struct super_block *sb, void *data, int silent)
129 {
130         static struct tree_descr files[] = {{""}};
131
132         return simple_fill_super(sb, SECURITYFS_MAGIC, files);
133 }
134
135 static int get_sb(struct file_system_type *fs_type,
136                   int flags, const char *dev_name,
137                   void *data, struct vfsmount *mnt)
138 {
139         return get_sb_single(fs_type, flags, data, fill_super, mnt);
140 }
141
142 static struct file_system_type fs_type = {
143         .owner =        THIS_MODULE,
144         .name =         "securityfs",
145         .get_sb =       get_sb,
146         .kill_sb =      kill_litter_super,
147 };
148
149 static int create_by_name(const char *name, mode_t mode,
150                           struct dentry *parent,
151                           struct dentry **dentry)
152 {
153         int error = 0;
154
155         *dentry = NULL;
156
157         /* If the parent is not specified, we create it in the root.
158          * We need the root dentry to do this, which is in the super
159          * block. A pointer to that is in the struct vfsmount that we
160          * have around.
161          */
162         if (!parent ) {
163                 if (mount && mount->mnt_sb) {
164                         parent = mount->mnt_sb->s_root;
165                 }
166         }
167         if (!parent) {
168                 pr_debug("securityfs: Ah! can not find a parent!\n");
169                 return -EFAULT;
170         }
171
172         mutex_lock(&parent->d_inode->i_mutex);
173         *dentry = lookup_one_len(name, parent, strlen(name));
174         if (!IS_ERR(dentry)) {
175                 if ((mode & S_IFMT) == S_IFDIR)
176                         error = mkdir(parent->d_inode, *dentry, mode);
177                 else
178                         error = create(parent->d_inode, *dentry, mode);
179         } else
180                 error = PTR_ERR(dentry);
181         mutex_unlock(&parent->d_inode->i_mutex);
182
183         return error;
184 }
185
186 /**
187  * securityfs_create_file - create a file in the securityfs filesystem
188  *
189  * @name: a pointer to a string containing the name of the file to create.
190  * @mode: the permission that the file should have
191  * @parent: a pointer to the parent dentry for this file.  This should be a
192  *          directory dentry if set.  If this parameter is %NULL, then the
193  *          file will be created in the root of the securityfs filesystem.
194  * @data: a pointer to something that the caller will want to get to later
195  *        on.  The inode.i_private pointer will point to this value on
196  *        the open() call.
197  * @fops: a pointer to a struct file_operations that should be used for
198  *        this file.
199  *
200  * This is the basic "create a file" function for securityfs.  It allows for a
201  * wide range of flexibility in creating a file, or a directory (if you
202  * want to create a directory, the securityfs_create_dir() function is
203  * recommended to be used instead).
204  *
205  * This function returns a pointer to a dentry if it succeeds.  This
206  * pointer must be passed to the securityfs_remove() function when the file is
207  * to be removed (no automatic cleanup happens if your module is unloaded,
208  * you are responsible here).  If an error occurs, the function will return
209  * the erorr value (via ERR_PTR).
210  *
211  * If securityfs is not enabled in the kernel, the value %-ENODEV is
212  * returned.
213  */
214 struct dentry *securityfs_create_file(const char *name, mode_t mode,
215                                    struct dentry *parent, void *data,
216                                    const struct file_operations *fops)
217 {
218         struct dentry *dentry = NULL;
219         int error;
220
221         pr_debug("securityfs: creating file '%s'\n",name);
222
223         error = simple_pin_fs(&fs_type, &mount, &mount_count);
224         if (error) {
225                 dentry = ERR_PTR(error);
226                 goto exit;
227         }
228
229         error = create_by_name(name, mode, parent, &dentry);
230         if (error) {
231                 dentry = ERR_PTR(error);
232                 simple_release_fs(&mount, &mount_count);
233                 goto exit;
234         }
235
236         if (dentry->d_inode) {
237                 if (fops)
238                         dentry->d_inode->i_fop = fops;
239                 if (data)
240                         dentry->d_inode->i_private = data;
241         }
242 exit:
243         return dentry;
244 }
245 EXPORT_SYMBOL_GPL(securityfs_create_file);
246
247 /**
248  * securityfs_create_dir - create a directory in the securityfs filesystem
249  *
250  * @name: a pointer to a string containing the name of the directory to
251  *        create.
252  * @parent: a pointer to the parent dentry for this file.  This should be a
253  *          directory dentry if set.  If this parameter is %NULL, then the
254  *          directory will be created in the root of the securityfs filesystem.
255  *
256  * This function creates a directory in securityfs with the given @name.
257  *
258  * This function returns a pointer to a dentry if it succeeds.  This
259  * pointer must be passed to the securityfs_remove() function when the file is
260  * to be removed (no automatic cleanup happens if your module is unloaded,
261  * you are responsible here).  If an error occurs, %NULL will be returned.
262  *
263  * If securityfs is not enabled in the kernel, the value %-ENODEV is
264  * returned.  It is not wise to check for this value, but rather, check for
265  * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
266  * code.
267  */
268 struct dentry *securityfs_create_dir(const char *name, struct dentry *parent)
269 {
270         return securityfs_create_file(name,
271                                       S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO,
272                                       parent, NULL, NULL);
273 }
274 EXPORT_SYMBOL_GPL(securityfs_create_dir);
275
276 /**
277  * securityfs_remove - removes a file or directory from the securityfs filesystem
278  *
279  * @dentry: a pointer to a the dentry of the file or directory to be removed.
280  *
281  * This function removes a file or directory in securityfs that was previously
282  * created with a call to another securityfs function (like
283  * securityfs_create_file() or variants thereof.)
284  *
285  * This function is required to be called in order for the file to be
286  * removed. No automatic cleanup of files will happen when a module is
287  * removed; you are responsible here.
288  */
289 void securityfs_remove(struct dentry *dentry)
290 {
291         struct dentry *parent;
292
293         if (!dentry)
294                 return;
295
296         parent = dentry->d_parent;
297         if (!parent || !parent->d_inode)
298                 return;
299
300         mutex_lock(&parent->d_inode->i_mutex);
301         if (positive(dentry)) {
302                 if (dentry->d_inode) {
303                         if (S_ISDIR(dentry->d_inode->i_mode))
304                                 simple_rmdir(parent->d_inode, dentry);
305                         else
306                                 simple_unlink(parent->d_inode, dentry);
307                         dput(dentry);
308                 }
309         }
310         mutex_unlock(&parent->d_inode->i_mutex);
311         simple_release_fs(&mount, &mount_count);
312 }
313 EXPORT_SYMBOL_GPL(securityfs_remove);
314
315 static struct kobject *security_kobj;
316
317 static int __init securityfs_init(void)
318 {
319         int retval;
320
321         security_kobj = kobject_create_and_add("security", kernel_kobj);
322         if (!security_kobj)
323                 return -EINVAL;
324
325         retval = register_filesystem(&fs_type);
326         if (retval)
327                 kobject_put(security_kobj);
328         return retval;
329 }
330
331 core_initcall(securityfs_init);
332 MODULE_LICENSE("GPL");
333