2 * BSD Secure Levels LSM
5 * Michael A. Halcrow <mike@halcrow.us>
6 * Serge Hallyn <hallyn@cs.wm.edu>
8 * Copyright (c) 2001 WireX Communications, Inc <chris@wirex.com>
9 * Copyright (c) 2001 Greg Kroah-Hartman <greg@kroah.com>
10 * Copyright (c) 2002 International Business Machines <robb@austin.ibm.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
18 #include <linux/config.h>
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/kernel.h>
22 #include <linux/init.h>
23 #include <linux/security.h>
24 #include <linux/netlink.h>
26 #include <linux/namei.h>
27 #include <linux/mount.h>
28 #include <linux/capability.h>
29 #include <linux/time.h>
30 #include <linux/proc_fs.h>
31 #include <linux/kobject.h>
32 #include <linux/crypto.h>
33 #include <asm/scatterlist.h>
34 #include <linux/gfp.h>
35 #include <linux/sysfs.h>
37 #define SHA1_DIGEST_SIZE 20
40 * Module parameter that defines the initial secure level.
42 * When built as a module, it defaults to seclvl 1, which is the
43 * behavior of BSD secure levels. Note that this default behavior
44 * wrecks havoc on a machine when the seclvl module is compiled into
45 * the kernel. In that case, we default to seclvl 0.
47 #ifdef CONFIG_SECURITY_SECLVL_MODULE
48 static int initlvl = 1;
52 module_param(initlvl, int, 0);
53 MODULE_PARM_DESC(initlvl, "Initial secure level (defaults to 1)");
55 /* Module parameter that defines the verbosity level */
57 module_param(verbosity, int, 0);
58 MODULE_PARM_DESC(verbosity, "Initial verbosity level (0 or 1; defaults to "
59 "0, which is Quiet)");
62 * Optional password which can be passed in to bring seclvl to 0
63 * (i.e., for halt/reboot). Defaults to NULL (the passwd attribute
64 * file will not be registered in sysfs).
66 * This gets converted to its SHA1 hash when stored. It's probably
67 * not a good idea to use this parameter when loading seclvl from a
68 * script; use sha1_passwd instead.
71 #define MAX_PASSWD_SIZE 32
72 static char passwd[MAX_PASSWD_SIZE];
73 module_param_string(passwd, passwd, sizeof(passwd), 0);
74 MODULE_PARM_DESC(passwd,
75 "Plaintext of password that sets seclvl=0 when written to "
76 "(sysfs mount point)/seclvl/passwd\n");
79 * SHA1 hashed version of the optional password which can be passed in
80 * to bring seclvl to 0 (i.e., for halt/reboot). Must be in
81 * hexadecimal format (40 characters). Defaults to NULL (the passwd
82 * attribute file will not be registered in sysfs).
84 * Use the sha1sum utility to generate the SHA1 hash of a password:
86 * echo -n "secret" | sha1sum
88 #define MAX_SHA1_PASSWD 41
89 static char sha1_passwd[MAX_SHA1_PASSWD];
90 module_param_string(sha1_passwd, sha1_passwd, sizeof(sha1_passwd), 0);
91 MODULE_PARM_DESC(sha1_passwd,
92 "SHA1 hash (40 hexadecimal characters) of password that "
93 "sets seclvl=0 when plaintext password is written to "
94 "(sysfs mount point)/seclvl/passwd\n");
96 static int hideHash = 1;
97 module_param(hideHash, int, 0);
98 MODULE_PARM_DESC(hideHash, "When set to 0, reading seclvl/passwd from sysfs "
99 "will return the SHA1-hashed value of the password that "
100 "lowers the secure level to 0.\n");
102 #define MY_NAME "seclvl"
105 * This time-limits log writes to one per second.
107 #define seclvl_printk(verb, type, fmt, arg...) \
109 if (verbosity >= verb) { \
110 static unsigned long _prior; \
111 unsigned long _now = jiffies; \
112 if ((_now - _prior) > HZ) { \
113 printk(type "%s: %s: " fmt, \
114 MY_NAME, __FUNCTION__ , \
122 * The actual security level. Ranges between -1 and 2 inclusive.
127 * flag to keep track of how we were registered
129 static int secondary;
132 * Verifies that the requested secure level is valid, given the current
135 static int seclvl_sanity(int reqlvl)
137 if ((reqlvl < -1) || (reqlvl > 2)) {
138 seclvl_printk(1, KERN_WARNING, "Attempt to set seclvl out of "
139 "range: [%d]\n", reqlvl);
142 if ((seclvl == 0) && (reqlvl == -1))
144 if (reqlvl < seclvl) {
145 seclvl_printk(1, KERN_WARNING, "Attempt to lower seclvl to "
153 * security level advancement rules:
154 * Valid levels are -1 through 2, inclusive.
155 * From -1, stuck. [ in case compiled into kernel ]
156 * From 0 or above, can only increment.
158 static void do_seclvl_advance(void *data, u64 val)
161 int newlvl = (int)val;
163 ret = seclvl_sanity(newlvl);
168 seclvl_printk(1, KERN_WARNING, "Cannot advance to seclvl "
173 seclvl_printk(1, KERN_WARNING, "Not allowed to advance to "
174 "seclvl [%d]\n", seclvl);
177 seclvl = newlvl; /* would it be more "correct" to set *data? */
181 static u64 seclvl_int_get(void *data)
186 DEFINE_SIMPLE_ATTRIBUTE(seclvl_file_ops, seclvl_int_get, do_seclvl_advance, "%lld\n");
188 static unsigned char hashedPassword[SHA1_DIGEST_SIZE];
191 * Converts a block of plaintext of into its SHA1 hashed value.
193 * It would be nice if crypto had a wrapper to do this for us linear
197 plaintext_to_sha1(unsigned char *hash, const char *plaintext, int len)
200 struct crypto_tfm *tfm;
201 struct scatterlist sg[1];
202 if (len > PAGE_SIZE) {
203 seclvl_printk(0, KERN_ERR, "Plaintext password too large (%d "
204 "characters). Largest possible is %lu "
205 "bytes.\n", len, PAGE_SIZE);
208 tfm = crypto_alloc_tfm("sha1", CRYPTO_TFM_REQ_MAY_SLEEP);
210 seclvl_printk(0, KERN_ERR,
211 "Failed to load transform for SHA1\n");
214 // Just get a new page; don't play around with page boundaries
216 pgVirtAddr = (char *)__get_free_page(GFP_KERNEL);
217 sg[0].page = virt_to_page(pgVirtAddr);
220 strncpy(pgVirtAddr, plaintext, len);
221 crypto_digest_init(tfm);
222 crypto_digest_update(tfm, sg, 1);
223 crypto_digest_final(tfm, hash);
224 crypto_free_tfm(tfm);
225 free_page((unsigned long)pgVirtAddr);
230 * Called whenever the user writes to the sysfs passwd handle to this kernel
231 * object. It hashes the password and compares the hashed results.
234 passwd_write_file(struct file * file, const char __user * buf,
235 size_t count, loff_t *ppos)
238 unsigned char tmp[SHA1_DIGEST_SIZE];
243 if (!*passwd && !*sha1_passwd) {
244 seclvl_printk(0, KERN_ERR, "Attempt to password-unlock the "
245 "seclvl module, but neither a plain text "
246 "password nor a SHA1 hashed password was "
247 "passed in as a module parameter! This is a "
248 "bug, since it should not be possible to be in "
249 "this part of the module; please tell a "
250 "maintainer about this event.\n");
254 if (count < 0 || count >= PAGE_SIZE)
258 page = (char *)get_zeroed_page(GFP_KERNEL);
262 if (copy_from_user(page, buf, count))
266 /* ``echo "secret" > seclvl/passwd'' includes a newline */
267 if (page[len - 1] == '\n')
269 /* Hash the password, then compare the hashed values */
270 if ((rc = plaintext_to_sha1(tmp, page, len))) {
271 seclvl_printk(0, KERN_ERR, "Error hashing password: rc = "
275 for (i = 0; i < SHA1_DIGEST_SIZE; i++) {
276 if (hashedPassword[i] != tmp[i])
279 seclvl_printk(0, KERN_INFO,
280 "Password accepted; seclvl reduced to 0.\n");
285 free_page((unsigned long)page);
289 static struct file_operations passwd_file_ops = {
290 .write = passwd_write_file,
294 * Explicitely disallow ptrace'ing the init process.
296 static int seclvl_ptrace(struct task_struct *parent, struct task_struct *child)
299 if (child->pid == 1) {
300 seclvl_printk(1, KERN_WARNING, "Attempt to ptrace "
301 "the init process dissallowed in "
302 "secure level %d\n", seclvl);
310 * Capability checks for seclvl. The majority of the policy
311 * enforcement for seclvl takes place here.
313 static int seclvl_capable(struct task_struct *tsk, int cap)
315 /* init can do anything it wants */
323 if (cap == CAP_LINUX_IMMUTABLE) {
324 seclvl_printk(1, KERN_WARNING, "Attempt to modify "
325 "the IMMUTABLE and/or APPEND extended "
326 "attribute on a file with the IMMUTABLE "
327 "and/or APPEND extended attribute set "
328 "denied in seclvl [%d]\n", seclvl);
330 } else if (cap == CAP_SYS_RAWIO) { // Somewhat broad...
331 seclvl_printk(1, KERN_WARNING, "Attempt to perform "
332 "raw I/O while in secure level [%d] "
335 } else if (cap == CAP_NET_ADMIN) {
336 seclvl_printk(1, KERN_WARNING, "Attempt to perform "
337 "network administrative task while "
338 "in secure level [%d] denied\n", seclvl);
340 } else if (cap == CAP_SETUID) {
341 seclvl_printk(1, KERN_WARNING, "Attempt to setuid "
342 "while in secure level [%d] denied\n",
345 } else if (cap == CAP_SETGID) {
346 seclvl_printk(1, KERN_WARNING, "Attempt to setgid "
347 "while in secure level [%d] denied\n",
349 } else if (cap == CAP_SYS_MODULE) {
350 seclvl_printk(1, KERN_WARNING, "Attempt to perform "
351 "a module operation while in secure "
352 "level [%d] denied\n", seclvl);
360 if (cap_is_fs_cap(cap) ? tsk->fsuid == 0 : tsk->euid == 0)
361 return 0; /* capability granted */
362 seclvl_printk(1, KERN_WARNING, "Capability denied\n");
363 return -EPERM; /* capability denied */
367 * Disallow reversing the clock in seclvl > 1
369 static int seclvl_settime(struct timespec *tv, struct timezone *tz)
371 if (tv && seclvl > 1) {
373 now = current_kernel_time();
374 if (tv->tv_sec < now.tv_sec ||
375 (tv->tv_sec == now.tv_sec && tv->tv_nsec < now.tv_nsec)) {
376 seclvl_printk(1, KERN_WARNING, "Attempt to decrement "
377 "time in secure level %d denied: "
378 "current->pid = [%d], "
379 "current->group_leader->pid = [%d]\n",
380 seclvl, current->pid,
381 current->group_leader->pid);
383 } /* if attempt to decrement time */
384 } /* if seclvl > 1 */
388 /* claim the blockdev to exclude mounters, release on file close */
389 static int seclvl_bd_claim(struct inode *inode)
392 struct block_device *bdev = NULL;
393 dev_t dev = inode->i_rdev;
394 bdev = open_by_devnum(dev, FMODE_WRITE);
396 if (bd_claim(bdev, &holder)) {
400 /* claimed, mark it to release on close */
401 inode->i_security = current;
406 /* release the blockdev if you claimed it */
407 static void seclvl_bd_release(struct inode *inode)
409 if (inode && S_ISBLK(inode->i_mode) && inode->i_security == current) {
410 struct block_device *bdev = inode->i_bdev;
414 inode->i_security = NULL;
420 * Security for writes to block devices is regulated by this seclvl
421 * function. Deny all writes to block devices in seclvl 2. In
422 * seclvl 1, we only deny writes to *mounted* block devices.
425 seclvl_inode_permission(struct inode *inode, int mask, struct nameidata *nd)
427 if (current->pid != 1 && S_ISBLK(inode->i_mode) && (mask & MAY_WRITE)) {
430 seclvl_printk(1, KERN_WARNING, "Write to block device "
431 "denied in secure level [%d]\n", seclvl);
434 if (seclvl_bd_claim(inode)) {
435 seclvl_printk(1, KERN_WARNING,
436 "Write to mounted block device "
437 "denied in secure level [%d]\n",
447 * The SUID and SGID bits cannot be set in seclvl >= 1
449 static int seclvl_inode_setattr(struct dentry *dentry, struct iattr *iattr)
452 if (iattr->ia_valid & ATTR_MODE)
453 if (iattr->ia_mode & S_ISUID ||
454 iattr->ia_mode & S_ISGID) {
455 seclvl_printk(1, KERN_WARNING, "Attempt to "
456 "modify SUID or SGID bit "
457 "denied in seclvl [%d]\n",
465 /* release busied block devices */
466 static void seclvl_file_free_security(struct file *filp)
468 struct dentry *dentry = filp->f_dentry;
469 struct inode *inode = NULL;
472 inode = dentry->d_inode;
473 seclvl_bd_release(inode);
478 * Cannot unmount in secure level 2
480 static int seclvl_umount(struct vfsmount *mnt, int flags)
482 if (current->pid == 1)
485 seclvl_printk(1, KERN_WARNING, "Attempt to unmount in secure "
486 "level %d\n", seclvl);
492 static struct security_operations seclvl_ops = {
493 .ptrace = seclvl_ptrace,
494 .capable = seclvl_capable,
495 .inode_permission = seclvl_inode_permission,
496 .inode_setattr = seclvl_inode_setattr,
497 .file_free_security = seclvl_file_free_security,
498 .settime = seclvl_settime,
499 .sb_umount = seclvl_umount,
503 * Process the password-related module parameters
505 static int processPassword(void)
508 hashedPassword[0] = '\0';
511 seclvl_printk(0, KERN_ERR, "Error: Both "
512 "passwd and sha1_passwd "
513 "were set, but they are mutually "
517 if ((rc = plaintext_to_sha1(hashedPassword, passwd,
519 seclvl_printk(0, KERN_ERR, "Error: SHA1 support not "
523 /* All static data goes to the BSS, which zero's the
524 * plaintext password out for us. */
525 } else if (*sha1_passwd) { // Base 16
527 i = strlen(sha1_passwd);
528 if (i != (SHA1_DIGEST_SIZE * 2)) {
529 seclvl_printk(0, KERN_ERR, "Received [%d] bytes; "
530 "expected [%d] for the hexadecimal "
531 "representation of the SHA1 hash of "
533 i, (SHA1_DIGEST_SIZE * 2));
536 while ((i -= 2) + 2) {
538 tmp = sha1_passwd[i + 2];
539 sha1_passwd[i + 2] = '\0';
540 hashedPassword[i / 2] = (unsigned char)
541 simple_strtol(&sha1_passwd[i], NULL, 16);
542 sha1_passwd[i + 2] = tmp;
549 * securityfs registrations
551 struct dentry *dir_ino, *seclvl_ino, *passwd_ino;
553 static int seclvlfs_register(void)
555 dir_ino = securityfs_create_dir("seclvl", NULL);
559 seclvl_ino = securityfs_create_file("seclvl", S_IRUGO | S_IWUSR,
560 dir_ino, &seclvl, &seclvl_file_ops);
563 if (*passwd || *sha1_passwd) {
564 passwd_ino = securityfs_create_file("passwd", S_IRUGO | S_IWUSR,
565 dir_ino, NULL, &passwd_file_ops);
572 securityfs_remove(dir_ino);
574 securityfs_remove(seclvl_ino);
580 * Initialize the seclvl module.
582 static int __init seclvl_init(void)
585 if (verbosity < 0 || verbosity > 1) {
586 printk(KERN_ERR "Error: bad verbosity [%d]; only 0 or 1 "
587 "are valid values\n", verbosity);
591 if (initlvl < -1 || initlvl > 2) {
592 seclvl_printk(0, KERN_ERR, "Error: bad initial securelevel "
598 if ((rc = processPassword())) {
599 seclvl_printk(0, KERN_ERR, "Error processing the password "
600 "module parameter(s): rc = [%d]\n", rc);
603 /* register ourselves with the security framework */
604 if (register_security(&seclvl_ops)) {
605 seclvl_printk(0, KERN_ERR,
606 "seclvl: Failure registering with the "
608 /* try registering with primary module */
609 rc = mod_reg_security(MY_NAME, &seclvl_ops);
611 seclvl_printk(0, KERN_ERR, "seclvl: Failure "
612 "registering with primary security "
615 } /* if primary module registered */
617 } /* if we registered ourselves with the security framework */
618 if ((rc = seclvlfs_register())) {
619 seclvl_printk(0, KERN_ERR, "Error registering with sysfs\n");
622 seclvl_printk(0, KERN_INFO, "seclvl: Successfully initialized.\n");
625 printk(KERN_ERR "seclvl: Error during initialization: rc = "
632 * Remove the seclvl module.
634 static void __exit seclvl_exit(void)
636 securityfs_remove(seclvl_ino);
637 if (*passwd || *sha1_passwd)
638 securityfs_remove(passwd_ino);
639 securityfs_remove(dir_ino);
640 if (secondary == 1) {
641 mod_unreg_security(MY_NAME, &seclvl_ops);
642 } else if (unregister_security(&seclvl_ops)) {
643 seclvl_printk(0, KERN_INFO,
644 "seclvl: Failure unregistering with the "
649 module_init(seclvl_init);
650 module_exit(seclvl_exit);
652 MODULE_AUTHOR("Michael A. Halcrow <mike@halcrow.us>");
653 MODULE_DESCRIPTION("LSM implementation of the BSD Secure Levels");
654 MODULE_LICENSE("GPL");