• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1SELinux Userspace
2=================
3
4![SELinux logo](https://github.com/SELinuxProject.png)
5[![Run Tests](https://github.com/SELinuxProject/selinux/actions/workflows/run_tests.yml/badge.svg)](https://github.com/SELinuxProject/selinux/actions/workflows/run_tests.yml)
6[![Run SELinux testsuite in a virtual machine](https://github.com/SELinuxProject/selinux/actions/workflows/vm_testsuite.yml/badge.svg)](https://github.com/SELinuxProject/selinux/actions/workflows/vm_testsuite.yml)
7[![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/selinux.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#selinux)
8[![CIFuzz Status](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml/badge.svg)](https://github.com/SELinuxProject/selinux/actions/workflows/cifuzz.yml)
9
10SELinux is a flexible Mandatory Access Control (MAC) system built into the
11Linux Kernel. SELinux provides administrators with a comprehensive access
12control mechanism that enables greater access granularity over the existing
13Linux Discretionary Access Controls (DAC) and is present in many major Linux
14distributions. This repository contains the sources for the SELinux utilities
15and system libraries which allow for the configuration and management of an
16SELinux-based system.
17
18Please submit all bug reports and patches to the <selinux@vger.kernel.org>
19mailing list. You can subscribe by sending "subscribe selinux" in the body of
20an email to <majordomo@vger.kernel.org>. Archives of the mailing list are
21available at https://lore.kernel.org/selinux.
22
23Installation
24------------
25
26SELinux libraries and tools are packaged in several Linux distributions:
27
28* Alpine Linux (https://pkgs.alpinelinux.org/package/edge/testing/x86/policycoreutils)
29* Arch Linux User Repository (https://aur.archlinux.org/packages/policycoreutils/)
30* Buildroot (https://git.buildroot.net/buildroot/tree/package/policycoreutils)
31* Debian and Ubuntu (https://packages.debian.org/sid/policycoreutils)
32* Gentoo (https://packages.gentoo.org/packages/sys-apps/policycoreutils)
33* RHEL and Fedora (https://src.fedoraproject.org/rpms/policycoreutils)
34* Yocto Project (http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/tree/recipes-security/selinux)
35* and many more (https://repology.org/project/policycoreutils/versions)
36
37
38Building and testing
39--------------------
40
41Build dependencies on Fedora:
42
43```sh
44# For C libraries and programs
45dnf install \
46    audit-libs-devel \
47    bison \
48    bzip2-devel \
49    CUnit-devel \
50    diffutils \
51    flex \
52    gcc \
53    gettext \
54    glib2-devel \
55    make \
56    libcap-devel \
57    libcap-ng-devel \
58    pam-devel \
59    pcre2-devel \
60    xmlto
61
62# For Python and Ruby bindings
63dnf install \
64    python3-devel \
65    python3-pip \
66    python3-setuptools \
67    python3-wheel \
68    ruby-devel \
69    swig
70```
71
72Build dependencies on Debian:
73
74```sh
75# For C libraries and programs
76apt-get install --no-install-recommends --no-install-suggests \
77    bison \
78    flex \
79    gawk \
80    gcc \
81    gettext \
82    make \
83    libaudit-dev \
84    libbz2-dev \
85    libcap-dev \
86    libcap-ng-dev \
87    libcunit1-dev \
88    libglib2.0-dev \
89    libpcre2-dev \
90    pkgconf \
91    python3 \
92    systemd \
93    xmlto
94
95# For Python and Ruby bindings
96apt-get install --no-install-recommends --no-install-suggests \
97    python3-dev \
98    python3-pip \
99    python3-setuptools \
100    python3-wheel \
101    ruby-dev \
102    swig
103```
104
105To build and install everything under a private directory, run:
106
107    make clean distclean
108
109    make DESTDIR=~/obj install install-rubywrap install-pywrap
110
111On Debian `PYTHON_SETUP_ARGS='--install-option "--install-layout=deb"'` needs to be set when installing the python wrappers in order to create the correct python directory structure.
112
113To 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`.
114This can be done using [./scripts/env_use_destdir](./scripts/env_use_destdir):
115
116    DESTDIR=~/obj ./scripts/env_use_destdir make test
117
118Some tests require the reference policy to be installed (for example in `python/sepolgen`).
119In order to run these ones, instructions similar to the ones in section `install` of [./.travis.yml](./.travis.yml) can be executed.
120
121To install as the default system libraries and binaries
122(overwriting any previously installed ones - dangerous!),
123on x86_64, run:
124
125    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
126
127or on x86 (32-bit), run:
128
129    make install install-pywrap relabel
130
131This may render your system unusable if the upstream SELinux userspace
132lacks library functions or other dependencies relied upon by your
133distribution.  If it breaks, you get to keep both pieces.
134
135
136## Setting CFLAGS
137
138Setting CFLAGS during the make process will cause the omission of many defaults. While the project strives
139to provide a reasonable set of default flags, custom CFLAGS could break the build, or have other undesired
140changes on the build output. Thus, be very careful when setting CFLAGS. CFLAGS that are encouraged to be
141set when overriding are:
142
143- -fno-semantic-interposition for gcc or compilers that do not do this. clang does this by default. clang-10 and up
144   will support passing this flag, but ignore it. Previous clang versions fail.
145
146
147macOS
148-----
149
150To install libsepol on macOS (mainly for policy analysis):
151
152    cd libsepol; make PREFIX=/usr/local install
153
154This requires GNU coreutils:
155
156    brew install coreutils
157