README.OpenSource
1[
2 {
3 "Name": "checkpolicy",
4 "License": "GPL V2.0",
5 "License File": "checkpolicy/COPYING",
6 "Version Number": "3.4",
7 "Owner": "jiangxiaofeng8@huawei.com",
8 "Upstream URL": "https://github.com/SELinuxProject/selinux",
9 "Description": "This module is the policy compiler which uses libsepol to generate the binary policy."
10 },
11 {
12 "Name": "libselinux",
13 "License": "Public Domain",
14 "License File": "libselinux/LICENSE",
15 "Version Number": "3.4",
16 "Owner": "jiangxiaofeng8@huawei.com",
17 "Upstream URL": "https://github.com/SELinuxProject/selinux",
18 "Description": "This module is the runtime SELinux library that provides interfaces to SELinux-aware applications."
19 },
20 {
21 "Name": "libsepol",
22 "License": "LGPL V2.1",
23 "License File": "libsepol/COPYING",
24 "Version Number": "3.4",
25 "Owner": "jiangxiaofeng8@huawei.com",
26 "Upstream URL": "https://github.com/SELinuxProject/selinux",
27 "Description": "This module is the binary policy manipulation library."
28 },
29 {
30 "Name": "secilc",
31 "License": "BSD 2-Clause License",
32 "License File": "secilc/COPYING",
33 "Version Number": "3.4",
34 "Owner": "jiangxiaofeng8@huawei.com",
35 "Upstream URL": "https://github.com/SELinuxProject/selinux",
36 "Description": "This module is a compiler which builds a kernel binary policy with cil files."
37 }
38]
39
README.md
1SELinux Userspace
2=================
3
4
5[](https://github.com/SELinuxProject/selinux/actions/workflows/run_tests.yml)
6[](https://github.com/SELinuxProject/selinux/actions/workflows/vm_testsuite.yml)
7[](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux)
8[](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml)
9
10Please submit all bug reports and patches to <selinux@vger.kernel.org>.
11
12Subscribe by sending "subscribe selinux" in the body of an email
13to <majordomo@vger.kernel.org>.
14
15Archive of this mailing list is available on https://lore.kernel.org/selinux/.
16
17
18Installation
19------------
20
21SELinux libraries and tools are packaged in several Linux distributions:
22
23* Alpine Linux (https://pkgs.alpinelinux.org/package/edge/testing/x86/policycoreutils)
24* Arch Linux User Repository (https://aur.archlinux.org/packages/policycoreutils/)
25* Buildroot (https://git.buildroot.net/buildroot/tree/package/policycoreutils)
26* Debian and Ubuntu (https://packages.debian.org/sid/policycoreutils)
27* Gentoo (https://packages.gentoo.org/packages/sys-apps/policycoreutils)
28* RHEL and Fedora (https://src.fedoraproject.org/rpms/policycoreutils)
29* Yocto Project (http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/tree/recipes-security/selinux)
30* and many more (https://repology.org/project/policycoreutils/versions)
31
32
33Building and testing
34--------------------
35
36Build dependencies on Fedora:
37
38```sh
39# For C libraries and programs
40dnf install \
41 audit-libs-devel \
42 bison \
43 bzip2-devel \
44 CUnit-devel \
45 diffutils \
46 flex \
47 gcc \
48 gettext \
49 glib2-devel \
50 make \
51 libcap-devel \
52 libcap-ng-devel \
53 pam-devel \
54 pcre-devel \
55 xmlto
56
57# For Python and Ruby bindings
58dnf install \
59 python3-devel \
60 ruby-devel \
61 swig
62```
63
64Build dependencies on Debian:
65
66```sh
67# For C libraries and programs
68apt-get install --no-install-recommends --no-install-suggests \
69 bison \
70 flex \
71 gawk \
72 gcc \
73 gettext \
74 make \
75 libaudit-dev \
76 libbz2-dev \
77 libcap-dev \
78 libcap-ng-dev \
79 libcunit1-dev \
80 libglib2.0-dev \
81 libpcre3-dev \
82 pkgconf \
83 python3 \
84 python3-distutils \
85 systemd \
86 xmlto
87
88# For Python and Ruby bindings
89apt-get install --no-install-recommends --no-install-suggests \
90 python3-dev \
91 ruby-dev \
92 swig
93```
94
95To build and install everything under a private directory, run:
96
97 make clean distclean
98
99 make DESTDIR=~/obj install install-rubywrap install-pywrap
100
101On Debian `PYTHON_SETUP_ARGS=--install-layout=deb` needs to be set when installing the python wrappers in order to create the correct python directory structure.
102
103To run tests with the built libraries and programs, several paths (relative to `$DESTDIR`) need to be added to variables `$LD_LIBRARY_PATH`, `$PATH` and `$PYTHONPATH`.
104This can be done using [./scripts/env_use_destdir](./scripts/env_use_destdir):
105
106 DESTDIR=~/obj ./scripts/env_use_destdir make test
107
108Some tests require the reference policy to be installed (for example in `python/sepolgen`).
109In order to run these ones, instructions similar to the ones in section `install` of [./.travis.yml](./.travis.yml) can be executed.
110
111To install as the default system libraries and binaries
112(overwriting any previously installed ones - dangerous!),
113on x86_64, run:
114
115 make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
116
117or on x86 (32-bit), run:
118
119 make install install-pywrap relabel
120
121This may render your system unusable if the upstream SELinux userspace
122lacks library functions or other dependencies relied upon by your
123distribution. If it breaks, you get to keep both pieces.
124
125
126## Setting CFLAGS
127
128Setting CFLAGS during the make process will cause the omission of many defaults. While the project strives
129to provide a reasonable set of default flags, custom CFLAGS could break the build, or have other undesired
130changes on the build output. Thus, be very careful when setting CFLAGS. CFLAGS that are encouraged to be
131set when overriding are:
132
133- -fno-semantic-interposition for gcc or compilers that do not do this. clang does this by default. clang-10 and up
134 will support passing this flag, but ignore it. Previous clang versions fail.
135
136
137macOS
138-----
139
140To install libsepol on macOS (mainly for policy analysis):
141
142 cd libsepol; make PREFIX=/usr/local install
143
144This requires GNU coreutils:
145
146 brew install coreutils
147
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}