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>
11 * Copyright (c) 2006 Davi E. M. Arnaut <davi.arnaut@gmail.com>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
19 #include <linux/err.h>
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/security.h>
25 #include <linux/netlink.h>
27 #include <linux/namei.h>
28 #include <linux/mount.h>
29 #include <linux/capability.h>
30 #include <linux/time.h>
31 #include <linux/proc_fs.h>
32 #include <linux/kobject.h>
33 #include <linux/crypto.h>
34 #include <asm/scatterlist.h>
35 #include <linux/scatterlist.h>
36 #include <linux/gfp.h>
37 #include <linux/sysfs.h>
39 #define SHA1_DIGEST_SIZE 20
42 * Module parameter that defines the initial secure level.
44 * When built as a module, it defaults to seclvl 1, which is the
45 * behavior of BSD secure levels. Note that this default behavior
46 * wrecks havoc on a machine when the seclvl module is compiled into
47 * the kernel. In that case, we default to seclvl 0.
49 #ifdef CONFIG_SECURITY_SECLVL_MODULE
50 static int initlvl
= 1;
54 module_param(initlvl
, int, 0);
55 MODULE_PARM_DESC(initlvl
, "Initial secure level (defaults to 1)");
57 /* Module parameter that defines the verbosity level */
59 module_param(verbosity
, int, 0);
60 MODULE_PARM_DESC(verbosity
, "Initial verbosity level (0 or 1; defaults to "
61 "0, which is Quiet)");
64 * Optional password which can be passed in to bring seclvl to 0
65 * (i.e., for halt/reboot). Defaults to NULL (the passwd attribute
66 * file will not be registered in sysfs).
68 * This gets converted to its SHA1 hash when stored. It's probably
69 * not a good idea to use this parameter when loading seclvl from a
70 * script; use sha1_passwd instead.
73 #define MAX_PASSWD_SIZE 32
74 static char passwd
[MAX_PASSWD_SIZE
];
75 module_param_string(passwd
, passwd
, sizeof(passwd
), 0);
76 MODULE_PARM_DESC(passwd
,
77 "Plaintext of password that sets seclvl=0 when written to "
78 "(sysfs mount point)/seclvl/passwd\n");
81 * SHA1 hashed version of the optional password which can be passed in
82 * to bring seclvl to 0 (i.e., for halt/reboot). Must be in
83 * hexadecimal format (40 characters). Defaults to NULL (the passwd
84 * attribute file will not be registered in sysfs).
86 * Use the sha1sum utility to generate the SHA1 hash of a password:
88 * echo -n "secret" | sha1sum
90 #define MAX_SHA1_PASSWD 41
91 static char sha1_passwd
[MAX_SHA1_PASSWD
];
92 module_param_string(sha1_passwd
, sha1_passwd
, sizeof(sha1_passwd
), 0);
93 MODULE_PARM_DESC(sha1_passwd
,
94 "SHA1 hash (40 hexadecimal characters) of password that "
95 "sets seclvl=0 when plaintext password is written to "
96 "(sysfs mount point)/seclvl/passwd\n");
98 static int hideHash
= 1;
99 module_param(hideHash
, int, 0);
100 MODULE_PARM_DESC(hideHash
, "When set to 0, reading seclvl/passwd from sysfs "
101 "will return the SHA1-hashed value of the password that "
102 "lowers the secure level to 0.\n");
104 #define MY_NAME "seclvl"
107 * This time-limits log writes to one per second.
109 #define seclvl_printk(verb, type, fmt, arg...) \
111 if (verbosity >= verb) { \
112 static unsigned long _prior; \
113 unsigned long _now = jiffies; \
114 if ((_now - _prior) > HZ) { \
115 printk(type "%s: %s: " fmt, \
116 MY_NAME, __FUNCTION__ , \
124 * The actual security level. Ranges between -1 and 2 inclusive.
129 * flag to keep track of how we were registered
131 static int secondary
;
134 * Verifies that the requested secure level is valid, given the current
137 static int seclvl_sanity(int reqlvl
)
139 if ((reqlvl
< -1) || (reqlvl
> 2)) {
140 seclvl_printk(1, KERN_WARNING
, "Attempt to set seclvl out of "
141 "range: [%d]\n", reqlvl
);
144 if ((seclvl
== 0) && (reqlvl
== -1))
146 if (reqlvl
< seclvl
) {
147 seclvl_printk(1, KERN_WARNING
, "Attempt to lower seclvl to "
155 * security level advancement rules:
156 * Valid levels are -1 through 2, inclusive.
157 * From -1, stuck. [ in case compiled into kernel ]
158 * From 0 or above, can only increment.
160 static void do_seclvl_advance(void *data
, u64 val
)
163 int newlvl
= (int)val
;
165 ret
= seclvl_sanity(newlvl
);
170 seclvl_printk(1, KERN_WARNING
, "Cannot advance to seclvl "
175 seclvl_printk(1, KERN_WARNING
, "Not allowed to advance to "
176 "seclvl [%d]\n", seclvl
);
179 seclvl
= newlvl
; /* would it be more "correct" to set *data? */
183 static u64
seclvl_int_get(void *data
)
188 DEFINE_SIMPLE_ATTRIBUTE(seclvl_file_ops
, seclvl_int_get
, do_seclvl_advance
, "%lld\n");
190 static unsigned char hashedPassword
[SHA1_DIGEST_SIZE
];
193 * Converts a block of plaintext of into its SHA1 hashed value.
195 * It would be nice if crypto had a wrapper to do this for us linear
199 plaintext_to_sha1(unsigned char *hash
, const char *plaintext
, unsigned int len
)
201 struct hash_desc desc
;
202 struct scatterlist sg
;
205 if (len
> PAGE_SIZE
) {
206 seclvl_printk(0, KERN_ERR
, "Plaintext password too large (%d "
207 "characters). Largest possible is %lu "
208 "bytes.\n", len
, PAGE_SIZE
);
211 desc
.tfm
= crypto_alloc_hash("sha1", 0, CRYPTO_ALG_ASYNC
);
212 if (IS_ERR(desc
.tfm
)) {
213 seclvl_printk(0, KERN_ERR
,
214 "Failed to load transform for SHA1\n");
217 sg_init_one(&sg
, (u8
*)plaintext
, len
);
218 desc
.flags
= CRYPTO_TFM_REQ_MAY_SLEEP
;
219 err
= crypto_hash_digest(&desc
, &sg
, len
, hash
);
220 crypto_free_hash(desc
.tfm
);
225 * Called whenever the user writes to the sysfs passwd handle to this kernel
226 * object. It hashes the password and compares the hashed results.
229 passwd_write_file(struct file
* file
, const char __user
* buf
,
230 size_t count
, loff_t
*ppos
)
234 unsigned char tmp
[SHA1_DIGEST_SIZE
];
236 if (!*passwd
&& !*sha1_passwd
) {
237 seclvl_printk(0, KERN_ERR
, "Attempt to password-unlock the "
238 "seclvl module, but neither a plain text "
239 "password nor a SHA1 hashed password was "
240 "passed in as a module parameter! This is a "
241 "bug, since it should not be possible to be in "
242 "this part of the module; please tell a "
243 "maintainer about this event.\n");
247 if (count
>= PAGE_SIZE
)
251 p
= kmalloc(count
, GFP_KERNEL
);
255 if (copy_from_user(p
, buf
, count
))
259 /* ``echo "secret" > seclvl/passwd'' includes a newline */
260 if (p
[len
- 1] == '\n')
262 /* Hash the password, then compare the hashed values */
263 if ((len
= plaintext_to_sha1(tmp
, p
, len
))) {
264 seclvl_printk(0, KERN_ERR
, "Error hashing password: rc = "
270 if (memcmp(hashedPassword
, tmp
, SHA1_DIGEST_SIZE
))
273 seclvl_printk(0, KERN_INFO
,
274 "Password accepted; seclvl reduced to 0.\n");
283 static struct file_operations passwd_file_ops
= {
284 .write
= passwd_write_file
,
288 * Explicitely disallow ptrace'ing the init process.
290 static int seclvl_ptrace(struct task_struct
*parent
, struct task_struct
*child
)
292 if (seclvl
>= 0 && child
->pid
== 1) {
293 seclvl_printk(1, KERN_WARNING
, "Attempt to ptrace "
294 "the init process dissallowed in "
295 "secure level %d\n", seclvl
);
302 * Capability checks for seclvl. The majority of the policy
303 * enforcement for seclvl takes place here.
305 static int seclvl_capable(struct task_struct
*tsk
, int cap
)
309 /* init can do anything it wants */
316 if (cap
== CAP_LINUX_IMMUTABLE
)
317 seclvl_printk(1, KERN_WARNING
, "Attempt to modify "
318 "the IMMUTABLE and/or APPEND extended "
319 "attribute on a file with the IMMUTABLE "
320 "and/or APPEND extended attribute set "
321 "denied in seclvl [%d]\n", seclvl
);
322 else if (cap
== CAP_SYS_RAWIO
)
323 seclvl_printk(1, KERN_WARNING
, "Attempt to perform "
324 "raw I/O while in secure level [%d] "
326 else if (cap
== CAP_NET_ADMIN
)
327 seclvl_printk(1, KERN_WARNING
, "Attempt to perform "
328 "network administrative task while "
329 "in secure level [%d] denied\n", seclvl
);
330 else if (cap
== CAP_SETUID
)
331 seclvl_printk(1, KERN_WARNING
, "Attempt to setuid "
332 "while in secure level [%d] denied\n",
334 else if (cap
== CAP_SETGID
)
335 seclvl_printk(1, KERN_WARNING
, "Attempt to setgid "
336 "while in secure level [%d] denied\n",
338 else if (cap
== CAP_SYS_MODULE
)
339 seclvl_printk(1, KERN_WARNING
, "Attempt to perform "
340 "a module operation while in secure "
341 "level [%d] denied\n", seclvl
);
347 if (!(cap_is_fs_cap(cap
) ? tsk
->fsuid
== 0 : tsk
->euid
== 0))
352 seclvl_printk(1, KERN_WARNING
, "Capability denied\n");
358 * Disallow reversing the clock in seclvl > 1
360 static int seclvl_settime(struct timespec
*tv
, struct timezone
*tz
)
362 if (tv
&& seclvl
> 1) {
364 now
= current_kernel_time();
365 if (tv
->tv_sec
< now
.tv_sec
||
366 (tv
->tv_sec
== now
.tv_sec
&& tv
->tv_nsec
< now
.tv_nsec
)) {
367 seclvl_printk(1, KERN_WARNING
, "Attempt to decrement "
368 "time in secure level %d denied: "
369 "current->pid = [%d], "
370 "current->group_leader->pid = [%d]\n",
371 seclvl
, current
->pid
,
372 current
->group_leader
->pid
);
374 } /* if attempt to decrement time */
375 } /* if seclvl > 1 */
379 /* claim the blockdev to exclude mounters, release on file close */
380 static int seclvl_bd_claim(struct inode
*inode
)
383 struct block_device
*bdev
= NULL
;
384 dev_t dev
= inode
->i_rdev
;
385 bdev
= open_by_devnum(dev
, FMODE_WRITE
);
387 if (bd_claim(bdev
, &holder
)) {
391 /* claimed, mark it to release on close */
392 inode
->i_security
= current
;
397 /* release the blockdev if you claimed it */
398 static void seclvl_bd_release(struct inode
*inode
)
400 if (inode
&& S_ISBLK(inode
->i_mode
) && inode
->i_security
== current
) {
401 struct block_device
*bdev
= inode
->i_bdev
;
405 inode
->i_security
= NULL
;
411 * Security for writes to block devices is regulated by this seclvl
412 * function. Deny all writes to block devices in seclvl 2. In
413 * seclvl 1, we only deny writes to *mounted* block devices.
416 seclvl_inode_permission(struct inode
*inode
, int mask
, struct nameidata
*nd
)
418 if (current
->pid
!= 1 && S_ISBLK(inode
->i_mode
) && (mask
& MAY_WRITE
)) {
421 seclvl_printk(1, KERN_WARNING
, "Write to block device "
422 "denied in secure level [%d]\n", seclvl
);
425 if (seclvl_bd_claim(inode
)) {
426 seclvl_printk(1, KERN_WARNING
,
427 "Write to mounted block device "
428 "denied in secure level [%d]\n",
438 * The SUID and SGID bits cannot be set in seclvl >= 1
440 static int seclvl_inode_setattr(struct dentry
*dentry
, struct iattr
*iattr
)
443 if (iattr
->ia_valid
& ATTR_MODE
)
444 if (iattr
->ia_mode
& S_ISUID
||
445 iattr
->ia_mode
& S_ISGID
) {
446 seclvl_printk(1, KERN_WARNING
, "Attempt to "
447 "modify SUID or SGID bit "
448 "denied in seclvl [%d]\n",
456 /* release busied block devices */
457 static void seclvl_file_free_security(struct file
*filp
)
459 struct dentry
*dentry
= filp
->f_dentry
;
462 seclvl_bd_release(dentry
->d_inode
);
466 * Cannot unmount in secure level 2
468 static int seclvl_umount(struct vfsmount
*mnt
, int flags
)
470 if (current
->pid
!= 1 && seclvl
== 2) {
471 seclvl_printk(1, KERN_WARNING
, "Attempt to unmount in secure "
472 "level %d\n", seclvl
);
478 static struct security_operations seclvl_ops
= {
479 .ptrace
= seclvl_ptrace
,
480 .capable
= seclvl_capable
,
481 .inode_permission
= seclvl_inode_permission
,
482 .inode_setattr
= seclvl_inode_setattr
,
483 .file_free_security
= seclvl_file_free_security
,
484 .settime
= seclvl_settime
,
485 .sb_umount
= seclvl_umount
,
489 * Process the password-related module parameters
491 static int processPassword(void)
498 seclvl_printk(0, KERN_ERR
, "Error: Both "
499 "passwd and sha1_passwd "
500 "were set, but they are mutually "
505 p
= kstrdup(passwd
, GFP_KERNEL
);
509 if ((rc
= plaintext_to_sha1(hashedPassword
, p
, strlen(p
))))
510 seclvl_printk(0, KERN_ERR
, "Error: SHA1 support not "
514 /* All static data goes to the BSS, which zero's the
515 * plaintext password out for us. */
516 } else if (*sha1_passwd
) { // Base 16
518 i
= strlen(sha1_passwd
);
519 if (i
!= (SHA1_DIGEST_SIZE
* 2)) {
520 seclvl_printk(0, KERN_ERR
, "Received [%d] bytes; "
521 "expected [%d] for the hexadecimal "
522 "representation of the SHA1 hash of "
524 i
, (SHA1_DIGEST_SIZE
* 2));
527 while ((i
-= 2) + 2) {
529 tmp
= sha1_passwd
[i
+ 2];
530 sha1_passwd
[i
+ 2] = '\0';
531 hashedPassword
[i
/ 2] = (unsigned char)
532 simple_strtol(&sha1_passwd
[i
], NULL
, 16);
533 sha1_passwd
[i
+ 2] = tmp
;
540 * securityfs registrations
542 struct dentry
*dir_ino
, *seclvl_ino
, *passwd_ino
;
544 static int seclvlfs_register(void)
548 dir_ino
= securityfs_create_dir("seclvl", NULL
);
551 return PTR_ERR(dir_ino
);
553 seclvl_ino
= securityfs_create_file("seclvl", S_IRUGO
| S_IWUSR
,
554 dir_ino
, &seclvl
, &seclvl_file_ops
);
555 if (IS_ERR(seclvl_ino
)) {
556 rc
= PTR_ERR(seclvl_ino
);
559 if (*passwd
|| *sha1_passwd
) {
560 passwd_ino
= securityfs_create_file("passwd", S_IRUGO
| S_IWUSR
,
561 dir_ino
, NULL
, &passwd_file_ops
);
562 if (IS_ERR(passwd_ino
)) {
563 rc
= PTR_ERR(passwd_ino
);
570 securityfs_remove(seclvl_ino
);
573 securityfs_remove(dir_ino
);
578 static void seclvlfs_unregister(void)
580 securityfs_remove(seclvl_ino
);
582 if (*passwd
|| *sha1_passwd
)
583 securityfs_remove(passwd_ino
);
585 securityfs_remove(dir_ino
);
589 * Initialize the seclvl module.
591 static int __init
seclvl_init(void)
596 if (verbosity
< 0 || verbosity
> 1) {
597 printk(KERN_ERR
"Error: bad verbosity [%d]; only 0 or 1 "
598 "are valid values\n", verbosity
);
602 if (initlvl
< -1 || initlvl
> 2) {
603 seclvl_printk(0, KERN_ERR
, "Error: bad initial securelevel "
609 if ((rc
= processPassword())) {
610 seclvl_printk(0, KERN_ERR
, "Error processing the password "
611 "module parameter(s): rc = [%d]\n", rc
);
615 if ((rc
= seclvlfs_register())) {
616 seclvl_printk(0, KERN_ERR
, "Error registering with sysfs\n");
619 /* register ourselves with the security framework */
620 if (register_security(&seclvl_ops
)) {
621 seclvl_printk(0, KERN_ERR
,
622 "seclvl: Failure registering with the "
624 /* try registering with primary module */
625 rc
= mod_reg_security(MY_NAME
, &seclvl_ops
);
627 seclvl_printk(0, KERN_ERR
, "seclvl: Failure "
628 "registering with primary security "
630 seclvlfs_unregister();
632 } /* if primary module registered */
634 } /* if we registered ourselves with the security framework */
636 seclvl_printk(0, KERN_INFO
, "seclvl: Successfully initialized.\n");
640 seclvl_printk(0, KERN_INFO
, "seclvl is going away. It has been "
641 "buggy for ages. Also, be warned that "
642 "Securelevels are useless.");
646 printk(KERN_ERR
"seclvl: Error during initialization: rc = "
652 * Remove the seclvl module.
654 static void __exit
seclvl_exit(void)
656 seclvlfs_unregister();
659 mod_unreg_security(MY_NAME
, &seclvl_ops
);
660 else if (unregister_security(&seclvl_ops
))
661 seclvl_printk(0, KERN_INFO
,
662 "seclvl: Failure unregistering with the "
666 module_init(seclvl_init
);
667 module_exit(seclvl_exit
);
669 MODULE_AUTHOR("Michael A. Halcrow <mike@halcrow.us>");
670 MODULE_DESCRIPTION("LSM implementation of the BSD Secure Levels");
671 MODULE_LICENSE("GPL");