blob: 2a7ab5cd06bae9b680259193353a07dfdc839514 [file] [log] [blame]
SE Android8c48de12012-01-24 05:27:18 -08001.TH CHECKMODULE 8
2.SH NAME
3checkmodule \- SELinux policy module compiler
4.SH SYNOPSIS
5.B checkmodule
Stephen Smalley968aed02013-10-30 15:38:49 -04006.I "[\-h] [\-b] [\-m] [\-M] [\-U handle_unknown ] [\-V] [\-o output_file] [input_file]"
SE Android8c48de12012-01-24 05:27:18 -08007.SH "DESCRIPTION"
8This manual page describes the
9.BR checkmodule
10command.
11.PP
12.B checkmodule
13is a program that checks and compiles a SELinux security policy module
14into a binary representation. It can generate either a base policy
Stephen Smalley968aed02013-10-30 15:38:49 -040015module (default) or a non-base policy module (\-m option); typically,
SE Android8c48de12012-01-24 05:27:18 -080016you would build a non-base policy module to add to an existing module
17store that already has a base module provided by the base policy. Use
18semodule_package to combine this module with its optional file
19contexts to create a policy package, and then use semodule to install
20the module package into the module store and load the resulting policy.
21
22.SH OPTIONS
23.TP
24.B \-b,\-\-binary
25Read an existing binary policy module file rather than a source policy
26module file. This option is a development/debugging aid.
27.TP
28.B \-h,\-\-help
29Print usage.
30.TP
31.B \-m
32Generate a non-base policy module.
33.TP
34.B \-M,\-\-mls
35Enable the MLS/MCS support when checking and compiling the policy module.
36.TP
37.B \-V,\-\-version
Stephen Smalleycd88c5c2012-02-21 14:27:00 -050038 Show policy versions created by this program. Note that you cannot currently build older versions.
SE Android8c48de12012-01-24 05:27:18 -080039.TP
40.B \-o,\-\-output filename
41Write a binary policy module file to the specified filename.
42Otherwise, checkmodule will only check the syntax of the module source file
43and will not generate a binary module at all.
44.TP
45.B \-U,\-\-handle-unknown <action>
46Specify how the kernel should handle unknown classes or permissions (deny, allow or reject).
47
48.SH EXAMPLE
49.nf
50# Build a MLS/MCS-enabled non-base policy module.
Stephen Smalley968aed02013-10-30 15:38:49 -040051$ checkmodule \-M \-m httpd.te \-o httpd.mod
SE Android8c48de12012-01-24 05:27:18 -080052.fi
53
54.SH "SEE ALSO"
55.B semodule(8), semodule_package(8)
Stephen Smalleyba8e9922012-09-25 10:57:09 -040056SELinux documentation at http://www.nsa.gov/research/selinux,
SE Android8c48de12012-01-24 05:27:18 -080057especially "Configuring the SELinux Policy".
58
59
60.SH AUTHOR
61This manual page was copied from the checkpolicy man page
62written by Arpad Magosanyi <mag@bunuel.tii.matav.hu>,
63and edited by Dan Walsh <dwalsh@redhat.com>.
64The program was written by Stephen Smalley <sds@epoch.ncsc.mil>.