Return to cvsd.8 CVS log

Up to [local] / src / usr.bin / cvs

Annotation of src/usr.bin/cvs/cvsd.8, Revision 1.5

1.5     ! jmc         1: .\"    $OpenBSD: cvsd.8,v 1.4 2004/12/02 22:38:30 jmc Exp $
1.1       jfb         2: .\"
                      3: .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
                      4: .\"
                      5: .\" Redistribution and use in source and binary forms, with or without
                      6: .\" modification, are permitted provided that the following conditions
                      7: .\" are met:
                      8: .\" 1. Redistributions of source code must retain the above copyright
                      9: .\"    notice, this list of conditions and the following disclaimer.
                     10: .\" 2. Redistributions in binary form must reproduce the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer in the
                     12: .\"    documentation and/or other materials provided with the distribution.
                     13: .\" 3. The name of the author may not be used to endorse or promote products
                     14: .\"    derived from this software without specific prior written permission.
                     15: .\"
                     16: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
                     17: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
                     18: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
                     19: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
                     20: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
                     21: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
                     22: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
                     23: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     24: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
                     25: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
                     26: .\"
                     27: .Dd May 16, 2004
                     28: .Dt CVSD 8
                     29: .Os
                     30: .Sh NAME
                     31: .Nm cvsd
                     32: .Nd Concurrent Versions System daemon
                     33: .Sh SYNOPSIS
                     34: .Nm cvsd
1.3       jfb        35: .Op Fl dfhpv
                     36: .Op Fl c Ar config
                     37: .Op Fl g Ar group
1.1       jfb        38: .Op Fl r Ar cvsroot
                     39: .Op Fl s Ar sockpath
1.3       jfb        40: .Op Fl u Ar user
1.1       jfb        41: .Sh DESCRIPTION
                     42: The
                     43: .Nm
                     44: daemon manages access to a CVS repository.
                     45: It provides a much more secure alternative to the traditional client-server
                     46: model commonly used by
                     47: .Xr cvs 1
                     48: through various mechanisms described below.
1.5     ! jmc        49: For a general introduction to CVS, see
        !            50: .Xr cvsintro 7 .
1.1       jfb        51: .Pp
1.4       jmc        52: On startup,
1.1       jfb        53: .Nm
                     54: spawns a child process that chroots to the CVS repository's root directory.
                     55: Both processes then drop privileges to user and group
                     56: .Ic _cvsd .
                     57: Once this is done, the child process loads the list of ACLs and opens a local
                     58: socket on which it listens for requests.
                     59: The parent process' only purpose is to answer requests for things outside of
                     60: the child's jail.
                     61: .Pp
1.2       jfb        62: .Nm
                     63: provides a way to apply Access Control Lists on the modules based on
1.4       jmc        64: operation, path, tags, and users.
1.1       jfb        65: In order to enforce ACLs and prevent users from modifying the files in the
                     66: repository directly, all of the files within the repository should be owned
                     67: by the user and group
                     68: .Ic _cvsd
                     69: and should only be writable by the user.
                     70: .Pp
                     71: The options are as follows:
                     72: .Bl -tag -width "-s sockpath"
1.3       jfb        73: .It Fl c Ar config
1.1       jfb        74: Use
1.3       jfb        75: .Ar config
                     76: as the startup configuration file instead of the default one.
1.1       jfb        77: .It Fl d
                     78: Start the server with debugging enabled.
                     79: This option overrides the
                     80: .Fl v
                     81: option.
                     82: .It Fl f
                     83: Stay in foreground instead of performing the usual operations to become
                     84: a daemon.
                     85: This causes all log messages to be printed on standard input or standard
                     86: error, depending on the priority of each message.
1.3       jfb        87: .It Fl g Ar group
                     88: Drop group privileges to the group name or GID specified by
                     89: .Ar group
                     90: instead of the default group.
                     91: .It Fl h
                     92: Print information about the server's usage and exit.
1.1       jfb        93: .It Fl p
                     94: On startup, perform a check on the whole contents of the CVS repository to
                     95: check file permissions and ownership, and print warnings for any files or
                     96: directories that do not match the expected permission masks.
                     97: When running with this option,
                     98: .Nm
                     99: will exit with an error message if any of the files have permissions that are
                    100: too open.
                    101: .It Fl r Ar cvsroot
                    102: Use
                    103: .Ar cvsroot
                    104: as the CVS repository's root directory.
                    105: .It Fl s Ar sockpath
                    106: Use the path specified by
                    107: .Ar sockpath
                    108: as the file to bind to for the local socket.
1.3       jfb       109: .It Fl u Ar user
                    110: Drop user privileges to the username or UID specified by
                    111: .Ar user
                    112: instead of the default user.
1.1       jfb       113: .It Fl v
                    114: Be verbose.
1.4       jmc       115: .El
1.1       jfb       116: .Sh FILES
                    117: .Bl -tag -width /var/run/cvsd.sock -compact
1.2       jfb       118: .It Pa /etc/cvsd.conf
                    119: Standard configuration file for the server.
1.1       jfb       120: .It Pa /var/run/cvsd.pid
                    121: Process ID of the currently running
                    122: .Nm .
                    123: .It Pa /var/run/cvsd.sock
                    124: Default listening socket for incoming cvs requests.
                    125: .El
                    126: .Sh SEE ALSO
                    127: .Xr cvs 1 ,
                    128: .Xr rcs 1 ,
1.2       jfb       129: .Xr cvsd.conf 5 ,
1.5     ! jmc       130: .Xr rcsfile 5 ,
        !           131: .Xr cvsintro 7
1.1       jfb       132: .Sh HISTORY
                    133: The
                    134: .Nm
1.4       jmc       135: server first appeared as part of the OpenCVS project.
1.1       jfb       136: .Sh AUTHORS
                    137: .An Jean-Francois Brousseau