blob: 54680e33933b1ee6734024aa41b488a67f180aac [file] [log] [blame]
Joshua Brindle13cd4c82008-08-19 15:30:36 -04001.TH CHECKMODULE 8
2.SH NAME
3checkmodule \- SELinux policy module compiler
4.SH SYNOPSIS
5.B checkmodule
Daniel J Walsh36fe4c32010-06-14 14:44:44 -04006.I "[-h] [-b] [-m] [-M] [-U handle_unknown ] [-V] [-o output_file] [input_file]"
Joshua Brindle13cd4c82008-08-19 15:30:36 -04007.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
15module (default) or a non-base policy module (-m option); typically,
16you 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
Guido Trentalanciabf57d232009-11-02 18:14:28 +010024.B \-b,\-\-binary
Joshua Brindle13cd4c82008-08-19 15:30:36 -040025Read an existing binary policy module file rather than a source policy
26module file. This option is a development/debugging aid.
27.TP
Steve Lawrence8867e162010-06-14 14:45:46 -040028.B \-h,\-\-help
Daniel J Walsh36fe4c32010-06-14 14:44:44 -040029Print usage.
30.TP
Joshua Brindle13cd4c82008-08-19 15:30:36 -040031.B \-m
32Generate a non-base policy module.
33.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010034.B \-M,\-\-mls
Joshua Brindle13cd4c82008-08-19 15:30:36 -040035Enable the MLS/MCS support when checking and compiling the policy module.
36.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010037.B \-V,\-\-version
Joshua Brindle13cd4c82008-08-19 15:30:36 -040038 Show policy versions created by this program
39.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010040.B \-o,\-\-output filename
Joshua Brindle13cd4c82008-08-19 15:30:36 -040041Write 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.
Guido Trentalanciabf57d232009-11-02 18:14:28 +010044.TP
45.B \-U,\-\-handle-unknown <action>
46Specify how the kernel should handle unknown classes or permissions (deny, allow or reject).
Joshua Brindle13cd4c82008-08-19 15:30:36 -040047
48.SH EXAMPLE
49.nf
50# Build a MLS/MCS-enabled non-base policy module.
51$ checkmodule -M -m httpd.te -o httpd.mod
52.fi
53
54.SH "SEE ALSO"
55.B semodule(8), semodule_package(8)
56SELinux documentation at http://www.nsa.gov/selinux,
57especially "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>.