selinux-policy/www/api-docs/kernel_selinux.html

885 lines
12 KiB
HTML
Raw Normal View History

2005-06-15 15:45:57 +00:00
<html>
<head>
<title>
Security Enhanced Linux Reference Policy
</title>
<style type="text/css" media="all">@import "style.css";</style>
</head>
<body>
<div id="Header">Security Enhanced Linux Reference Policy</div>
<div id='Menu'>
<a href="admin.html">+&nbsp;
admin</a></br/>
<div id='subitem'>
</div>
2005-07-05 13:36:21 +00:00
<a href="apps.html">+&nbsp;
apps</a></br/>
<div id='subitem'>
</div>
2005-06-15 15:45:57 +00:00
<a href="kernel.html">+&nbsp;
kernel</a></br/>
<div id='subitem'>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_bootloader.html'>
bootloader</a><br/>
2005-12-07 15:46:38 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_corecommands.html'>
corecommands</a><br/>
2005-06-15 15:45:57 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_corenetwork.html'>
corenetwork</a><br/>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_devices.html'>
devices</a><br/>
2005-12-07 15:46:38 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_domain.html'>
domain</a><br/>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_files.html'>
files</a><br/>
2005-06-15 15:45:57 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_filesystem.html'>
filesystem</a><br/>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_kernel.html'>
kernel</a><br/>
2005-10-19 21:12:22 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_mls.html'>
mls</a><br/>
2005-06-15 15:45:57 +00:00
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_selinux.html'>
selinux</a><br/>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_storage.html'>
storage</a><br/>
&nbsp;&nbsp;&nbsp;-&nbsp;<a href='kernel_terminal.html'>
terminal</a><br/>
</div>
<a href="services.html">+&nbsp;
services</a></br/>
<div id='subitem'>
</div>
<a href="system.html">+&nbsp;
system</a></br/>
<div id='subitem'>
</div>
<br/><p/>
2005-08-02 17:21:46 +00:00
<a href="global_booleans.html">*&nbsp;Global&nbsp;Booleans&nbsp;</a>
2005-07-05 13:36:21 +00:00
<br/><p/>
2005-08-02 17:21:46 +00:00
<a href="global_tunables.html">*&nbsp;Global&nbsp;Tunables&nbsp;</a>
<p/><br/><p/>
<a href="index.html">*&nbsp;Layer Index</a>
<br/><p/>
<a href="interfaces.html">*&nbsp;Interface&nbsp;Index</a>
<br/><p/>
<a href="templates.html">*&nbsp;Template&nbsp;Index</a>
2005-06-15 15:45:57 +00:00
</div>
<div id="Content">
2005-07-05 13:36:21 +00:00
<a name="top":></a>
2005-06-15 15:45:57 +00:00
<h1>Layer: kernel</h1><p/>
<h2>Module: selinux</h2><p/>
2005-07-05 13:36:21 +00:00
2005-06-15 15:45:57 +00:00
<h3>Description:</h3>
2005-07-07 17:19:13 +00:00
<p><p>
2005-06-15 15:45:57 +00:00
Policy for kernel security interface, in particular, selinuxfs.
2005-07-07 17:19:13 +00:00
</p></p>
<p>This module is required to be included in all policies.</p>
2005-06-15 15:45:57 +00:00
2005-07-05 13:36:21 +00:00
<a name="interfaces"></a>
2005-06-15 15:45:57 +00:00
<h3>Interfaces: </h3>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_compute_access_vector"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_compute_access_vector</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allows caller to compute an access vector.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type allowed to compute an access vector.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_compute_create_context"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_compute_create_context</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-08-26 15:28:46 +00:00
Calculate the default type for object creation.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-09-22 18:40:05 +00:00
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain allowed access.
</td><td>
No
</td></tr>
</table>
</div>
</div>
<a name="link_selinux_compute_member"></a>
<div id="interface">
<div id="codeblock">
<b>selinux_compute_member</b>(
domain
)<br>
</div>
<div id="description">
<h5>Summary</h5>
<p>
Allows caller to compute polyinstatntiated
directory members.
</p>
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-08-26 15:28:46 +00:00
Domain allowed access.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_compute_relabel_context"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_compute_relabel_context</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-08-26 15:28:46 +00:00
Calculate the context for relabeling objects.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-08-26 15:28:46 +00:00
<h5>Description</h5>
<p>
</p><p>
Calculate the context for relabeling objects.
This is determined by using the type_change
rules in the policy, and is generally used
for determining the context for relabeling
a terminal when a user logs in.
</p><p>
</p>
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-08-26 15:28:46 +00:00
Domain allowed access.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_compute_user_contexts"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_compute_user_contexts</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allows caller to compute possible contexts for a user.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type allowed to compute user contexts.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-09-07 14:45:49 +00:00
<a name="link_selinux_dontaudit_getattr_dir"></a>
<div id="interface">
<div id="codeblock">
<b>selinux_dontaudit_getattr_dir</b>(
domain
)<br>
</div>
<div id="description">
<h5>Summary</h5>
<p>
Do not audit attempts to get the
attributes of the selinuxfs directory.
</p>
2005-12-07 15:46:38 +00:00
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain to not audit.
</td><td>
No
</td></tr>
</table>
</div>
</div>
<a name="link_selinux_dontaudit_read_fs"></a>
<div id="interface">
<div id="codeblock">
<b>selinux_dontaudit_read_fs</b>(
domain
)<br>
</div>
<div id="description">
<h5>Summary</h5>
<p>
Do not audit attempts to read
generic selinuxfs entries
</p>
2005-09-07 14:45:49 +00:00
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain to not audit.
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_dontaudit_search_fs"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
2005-08-02 17:21:46 +00:00
<b>selinux_dontaudit_search_fs</b>(
2005-06-15 15:45:57 +00:00
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
<p>
Do not audit attempts to search selinuxfs.
</p>
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain to not audit.
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<a name="link_selinux_get_enforce_mode"></a>
<div id="interface">
<div id="codeblock">
<b>selinux_get_enforce_mode</b>(
domain
)<br>
</div>
<div id="description">
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allows the caller to get the mode of policy enforcement
(enforcing or permissive mode).
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type to allow to get the enforcing mode.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_get_fs_mount"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_get_fs_mount</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Gets the caller the mountpoint of the selinuxfs filesystem.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type requesting the selinuxfs mountpoint.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_load_policy"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_load_policy</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allow caller to load the policy into the kernel.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type that will load the policy.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-10-19 21:12:22 +00:00
<a name="link_selinux_search_fs"></a>
<div id="interface">
<div id="codeblock">
<b>selinux_search_fs</b>(
domain
)<br>
</div>
<div id="description">
<h5>Summary</h5>
<p>
Search selinuxfs.
</p>
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain allowed access.
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_set_boolean"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_set_boolean</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allow caller to set the state of Booleans to
enable or disable conditional portions of the policy.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-08-26 15:28:46 +00:00
<h5>Description</h5>
<p>
</p><p>
Allow caller to set the state of Booleans to
enable or disable conditional portions of the policy.
</p><p>
</p><p>
Since this is a security event, this action is
always audited.
</p><p>
</p>
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type allowed to set the Boolean.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_set_enforce_mode"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_set_enforce_mode</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allow caller to set the mode of policy enforcement
(enforcing or permissive mode).
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-08-26 15:28:46 +00:00
<h5>Description</h5>
<p>
</p><p>
Allow caller to set the mode of policy enforcement
(enforcing or permissive mode).
</p><p>
</p><p>
Since this is a security event, this action is
always audited.
</p><p>
</p>
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type to allow to set the enforcement mode.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_set_parameters"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
<div id="codeblock">
<b>selinux_set_parameters</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-08-26 15:28:46 +00:00
Allow caller to set SELinux access vector cache parameters.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-08-26 15:28:46 +00:00
<h5>Description</h5>
<p>
</p><p>
Allow caller to set SELinux access vector cache parameters.
The allows the domain to set performance related parameters
of the AVC, such as cache threshold.
</p><p>
</p><p>
Since this is a security event, this action is
always audited.
</p><p>
</p>
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type to allow to set security parameters.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_unconfined"></a>
2005-06-15 15:45:57 +00:00
<div id="interface">
2005-07-07 17:19:13 +00:00
<div id="codeblock">
<b>selinux_unconfined</b>(
domain
)<br>
</div>
<div id="description">
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-07-07 17:19:13 +00:00
<p>
2005-08-26 15:28:46 +00:00
Unconfined access to the SELinux kernel security server.
2005-07-07 17:19:13 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-07-07 17:19:13 +00:00
<h5>Parameters</h5>
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
Domain allowed access.
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-08-02 17:21:46 +00:00
<a name="link_selinux_validate_context"></a>
2005-07-07 17:19:13 +00:00
<div id="interface">
2005-06-15 15:45:57 +00:00
<div id="codeblock">
<b>selinux_validate_context</b>(
domain
)<br>
</div>
<div id="description">
2005-06-15 21:11:49 +00:00
2005-08-02 17:21:46 +00:00
<h5>Summary</h5>
2005-06-15 15:45:57 +00:00
<p>
2005-07-05 13:36:21 +00:00
Allows caller to validate security contexts.
2005-06-15 21:11:49 +00:00
</p>
2005-08-02 17:21:46 +00:00
2005-06-15 21:11:49 +00:00
<h5>Parameters</h5>
2005-06-15 15:45:57 +00:00
<table border="1" cellspacing="0" cellpadding="3" width="80%">
<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
<tr><td>
domain
</td><td>
2005-07-05 13:36:21 +00:00
The process type permitted to validate contexts.
2005-06-15 15:45:57 +00:00
</td><td>
No
</td></tr>
</table>
</div>
</div>
2005-07-05 13:36:21 +00:00
<a href=#top>Return</a>
2005-06-15 15:45:57 +00:00
2005-09-07 14:45:49 +00:00
2005-06-15 15:45:57 +00:00
</div>
</body>
</html>