~ubuntu-branches/ubuntu/lucid/rsyslog/lucid-updates

« back to all changes in this revision

Viewing changes to doc/droppriv.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2009-06-23 12:12:43 UTC
  • mfrom: (1.1.11 upstream) (3.2.8 sid)
  • Revision ID: james.westby@ubuntu.com-20090623121243-d2fejarzidywnn17
Tags: 4.2.0-1
* New upstream release of the now stable v4 branch.
  - Fix warnings when /etc/rsyslog.d/ is empty. Closes: #530228
* debian/patches/imudp_multiple_udp_sockets.patch
  - Removed, merged upstream.
* debian/rsyslog.default
  - Set default compat mode to '4'.
* debian/rsyslog.logcheck.ignore.server
  - Update logcheck rules files to also ignore rsyslogd and imklog stop
    messages.
* debian/control
  - Bump Standards-Version to 3.8.2. No further changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><title>dropping privileges in rsyslog</title>
 
3
</head>
 
4
<body>
 
5
<h1>Dropping privileges in rsyslog</h1>
 
6
<p><b>Available since:&nbsp;&nbsp;&nbsp;</b> 4.1.1</p>
 
7
<p><b>Description</b>:</p>
 
8
<p>
 
9
Rsyslogd provides the ability to drop privileges by
 
10
impersonating as another user and/or group after startup.
 
11
 
 
12
<p>Please note that due to POSIX standards, rsyslogd always needs to start
 
13
up as root if there is a listener who must bind to a network port below 1024.
 
14
For example, the UDP listener usually needs to listen to 514 and as such
 
15
rsyslogd needs to start up as root.
 
16
 
 
17
<p>If you do not need this functionality, you can start rsyslog directly as an ordinary
 
18
user. That is probably the safest way of operations. However, if a startup as
 
19
root is required, you can use the $PrivDropToGroup and $PrivDropToUser config
 
20
directives to specify a group and/or user that rsyslogd should drop to after initialization.
 
21
Once this happend, the daemon runs without high privileges (depending, of
 
22
course, on the permissions of the user account you specified). 
 
23
<p>There is some additional information available in the
 
24
<a href="http://wiki.rsyslog.com/index.php/Security#Dropping_Privileges">rsyslog wiki</a>.
 
25
<p><b>Configuration Directives</b>:</p>
 
26
<ul>
 
27
<li><b>$PrivDropToUser</b><br>
 
28
Name of the user rsyslog should run under after startup. Please note that
 
29
this user is looked up in the system tables. If the lookup fails, privileges are
 
30
NOT dropped. Thus it is advisable to use the less convenient $PrivDropToUserID directive.
 
31
If the user id can be looked up, but can not be set, rsyslog aborts.
 
32
<br>
 
33
</li>
 
34
<li><b>$PrivDropToUserID</b><br>
 
35
Much the same as $PrivDropToUser, except that a numerical user id instead of a name
 
36
is specified.Thus, privilege drop will always happen. 
 
37
rsyslogd aborts.
 
38
<li><b>$PrivDropToGroup</b><br>
 
39
Name of the group rsyslog should run under after startup. Please note that
 
40
this user is looked up in the system tables. If the lookup fails, privileges are
 
41
NOT dropped. Thus it is advisable to use the less convenient $PrivDropToGroupID directive.
 
42
Note that all supplementary groups are removed from the process if $PrivDropToGroup is
 
43
specified.
 
44
If the group id can be looked up, but can not be set, rsyslog aborts.
 
45
<br>
 
46
</li>
 
47
<li><b>$PrivDropToGroupID</b><br>
 
48
Much the same as $PrivDropToGroup, except that a numerical group id instead of a name
 
49
is specified. Thus, privilege drop will always happen.
 
50
</ul>
 
51
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
 
52
[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
 
53
<p><font size="2">This documentation is part of the <a href="http://www.rsyslog.com/">rsyslog</a>
 
54
project.<br>
 
55
Copyright &copy; 2008 by <a href="http://www.gerhards.net/rainer">Rainer
 
56
Gerhards</a> and
 
57
<a href="http://www.adiscon.com/">Adiscon</a>.
 
58
Released under the GNU GPL version 3 or higher.</font></p>
 
59
 
 
60
</body></html>