Return to cvsd.8 CVS log

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

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

1.3     ! jfb         1: .\"    $OpenBSD$
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.
                     49: .Pp
                     50: On startup,
                     51: .Nm
                     52: spawns a child process that chroots to the CVS repository's root directory.
                     53: Both processes then drop privileges to user and group
                     54: .Ic _cvsd .
                     55: Once this is done, the child process loads the list of ACLs and opens a local
                     56: socket on which it listens for requests.
                     57: The parent process' only purpose is to answer requests for things outside of
                     58: the child's jail.
                     59: .Pp
1.2       jfb        60: .Nm
                     61: provides a way to apply Access Control Lists on the modules based on
                     62: operation, path, tags and users.
1.1       jfb        63: In order to enforce ACLs and prevent users from modifying the files in the
                     64: repository directly, all of the files within the repository should be owned
                     65: by the user and group
                     66: .Ic _cvsd
                     67: and should only be writable by the user.
                     68: .Pp
                     69: The options are as follows:
                     70: .Bl -tag -width "-s sockpath"
1.3     ! jfb        71: .It Fl c Ar config
1.1       jfb        72: Use
1.3     ! jfb        73: .Ar config
        !            74: as the startup configuration file instead of the default one.
1.1       jfb        75: .It Fl d
                     76: Start the server with debugging enabled.
                     77: This option overrides the
                     78: .Fl v
                     79: option.
                     80: .It Fl f
                     81: Stay in foreground instead of performing the usual operations to become
                     82: a daemon.
                     83: This causes all log messages to be printed on standard input or standard
                     84: error, depending on the priority of each message.
1.3     ! jfb        85: .It Fl g Ar group
        !            86: Drop group privileges to the group name or GID specified by
        !            87: .Ar group
        !            88: instead of the default group.
        !            89: .It Fl h
        !            90: Print information about the server's usage and exit.
1.1       jfb        91: .It Fl p
                     92: On startup, perform a check on the whole contents of the CVS repository to
                     93: check file permissions and ownership, and print warnings for any files or
                     94: directories that do not match the expected permission masks.
                     95: When running with this option,
                     96: .Nm
                     97: will exit with an error message if any of the files have permissions that are
                     98: too open.
                     99: .It Fl r Ar cvsroot
                    100: Use
                    101: .Ar cvsroot
                    102: as the CVS repository's root directory.
                    103: .It Fl s Ar sockpath
                    104: Use the path specified by
                    105: .Ar sockpath
                    106: as the file to bind to for the local socket.
1.3     ! jfb       107: .It Fl u Ar user
        !           108: Drop user privileges to the username or UID specified by
        !           109: .Ar user
        !           110: instead of the default user.
1.1       jfb       111: .It Fl v
                    112: Be verbose.
                    113: .Sh FILES
                    114: .Bl -tag -width /var/run/cvsd.sock -compact
1.2       jfb       115: .It Pa /etc/cvsd.conf
                    116: Standard configuration file for the server.
1.1       jfb       117: .It Pa /var/run/cvsd.pid
                    118: Process ID of the currently running
                    119: .Nm .
                    120: .It Pa /var/run/cvsd.sock
                    121: Default listening socket for incoming cvs requests.
                    122: .El
                    123: .Sh SEE ALSO
                    124: .Xr cvs 1 ,
                    125: .Xr rcs 1 ,
1.2       jfb       126: .Xr cvsd.conf 5 ,
                    127: .Xr rcsfile 5
1.1       jfb       128: .Sh HISTORY
                    129: The
                    130: .Nm
                    131: server appeared as part of the OpenCVS project.
                    132: .Sh AUTHORS
                    133: .An Jean-Francois Brousseau