op public repos

Blame

Date:: Sun Oct 23 00:37:19 2022 UTC
Message:: introduce gotd(8), a Git repository server reachable via ssh(1) This is an initial barebones implementation which provides the absolute minimum of functionality required to serve got(1) and git(1) clients. Basic fetch/send functionality has been tested and seems to work here, but this server is not yet expected to be stable. More testing is welcome. See the man pages for setup instructions. The current design uses one reader and one writer process per repository, which will have to be extended to N readers and N writers in the future. At startup, each process will chroot(2) into its assigned repository. This works because gotd(8) can only be started as root, and will then fork+exec, chroot, and privdrop. At present the parent process runs with the following pledge(2) promises: "stdio rpath wpath cpath proc getpw sendfd recvfd fattr flock unix unveil" The parent is the only process able to modify the repository in a way that becomes visible to Git clients. The parent uses unveil(2) to restrict its view of the filesystem to /tmp and the repositories listed in the configuration file gotd.conf(5). Per-repository chroot(2) processes use "stdio rpath sendfd recvfd". The writer defers to the parent for modifying references in the repository to point at newly uploaded commits. The reader is fine without such help, because Git repositories can be read without having to create any lock-files. gotd(8) requires a dedicated user ID, which should own repositories on the filesystem, and a separate secondary group, which should not have filesystem-level repository access, and must be allowed access to the gotd(8) socket. To obtain Git repository access, users must be members of this secondary group, and must have their login shell set to gotsh(1). gotsh(1) connects to the gotd(8) socket and speaks Git-protocol towards the client on the other end of the SSH connection. gotsh(1) is not an interactive command shell. At present, authenticated clients are granted read/write access to all repositories and all references (except for the "refs/got/" and the "refs/remotes/" namespaces, which are already being protected from modification). While complicated access control mechanism are not a design goal, making it possible to safely offer anonymous Git repository access over ssh(1) is on the road map.
Actions:: History | Blob | Raw File

 1 13b2bc37 2022-10-23 stsp .\"
 2 13b2bc37 2022-10-23 stsp .\" Copyright (c) 2022 Stefan Sperling
 3 13b2bc37 2022-10-23 stsp .\"
 4 13b2bc37 2022-10-23 stsp .\" Permission to use, copy, modify, and distribute this software for any
 5 13b2bc37 2022-10-23 stsp .\" purpose with or without fee is hereby granted, provided that the above
 6 13b2bc37 2022-10-23 stsp .\" copyright notice and this permission notice appear in all copies.
 7 13b2bc37 2022-10-23 stsp .\"
 8 13b2bc37 2022-10-23 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9 13b2bc37 2022-10-23 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 13b2bc37 2022-10-23 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 13b2bc37 2022-10-23 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 13b2bc37 2022-10-23 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 13b2bc37 2022-10-23 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 13b2bc37 2022-10-23 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 13b2bc37 2022-10-23 stsp .\"
16 13b2bc37 2022-10-23 stsp .Dd $Mdocdate$
17 13b2bc37 2022-10-23 stsp .Dt GOTD 8
18 13b2bc37 2022-10-23 stsp .Os
19 13b2bc37 2022-10-23 stsp .Sh NAME
20 13b2bc37 2022-10-23 stsp .Nm gotd
21 13b2bc37 2022-10-23 stsp .Nd Game of Trees Daemon
22 13b2bc37 2022-10-23 stsp .Sh SYNOPSIS
23 13b2bc37 2022-10-23 stsp .Nm
24 13b2bc37 2022-10-23 stsp .Op Fl dv
25 13b2bc37 2022-10-23 stsp .Op Fl f Ar config-file
26 13b2bc37 2022-10-23 stsp .Sh DESCRIPTION
27 13b2bc37 2022-10-23 stsp .Nm
28 13b2bc37 2022-10-23 stsp is a Git repository server which listens on a
29 13b2bc37 2022-10-23 stsp .Xr unix 4
30 13b2bc37 2022-10-23 stsp socket and relies on its companion tool
31 13b2bc37 2022-10-23 stsp .Xr gotsh 1
32 13b2bc37 2022-10-23 stsp to handle Git-protocol communication over the network, via
33 13b2bc37 2022-10-23 stsp .Xr ssh 1 .
34 13b2bc37 2022-10-23 stsp .Pp
35 13b2bc37 2022-10-23 stsp The Git repository format is described in
36 13b2bc37 2022-10-23 stsp .Xr git-repository 5 .
37 13b2bc37 2022-10-23 stsp .Pp
38 13b2bc37 2022-10-23 stsp .Nm
39 13b2bc37 2022-10-23 stsp requires a configuration file in order to run.
40 13b2bc37 2022-10-23 stsp The configuration file format is described in
41 13b2bc37 2022-10-23 stsp .Xr gotd.conf 5 .
42 13b2bc37 2022-10-23 stsp .Pp
43 13b2bc37 2022-10-23 stsp The options for
44 13b2bc37 2022-10-23 stsp .Nm
45 13b2bc37 2022-10-23 stsp are as follows:
46 13b2bc37 2022-10-23 stsp .Bl -tag -width Ds
47 13b2bc37 2022-10-23 stsp .It Fl d
48 13b2bc37 2022-10-23 stsp Do not daemonize and log to stderr.
49 13b2bc37 2022-10-23 stsp .It Fl f Ar config-file
50 13b2bc37 2022-10-23 stsp Set the path to the configuration file.
51 13b2bc37 2022-10-23 stsp If not specified, the file
52 13b2bc37 2022-10-23 stsp .Pa /etc/gotd.conf
53 13b2bc37 2022-10-23 stsp will be used.
54 13b2bc37 2022-10-23 stsp .It Fl v
55 13b2bc37 2022-10-23 stsp Verbose mode.
56 13b2bc37 2022-10-23 stsp Verbosity increases if this option is used multiple times.
57 13b2bc37 2022-10-23 stsp .Sh FILES
58 13b2bc37 2022-10-23 stsp .Bl -tag -width Ds -compact
59 13b2bc37 2022-10-23 stsp .It Pa /etc/gotd.conf
60 13b2bc37 2022-10-23 stsp Default location of the configuration file.
61 13b2bc37 2022-10-23 stsp .It Pa /var/run/gotd.sock
62 13b2bc37 2022-10-23 stsp Default location of the unix socket which
63 13b2bc37 2022-10-23 stsp .Nm
64 13b2bc37 2022-10-23 stsp is listening on.
65 13b2bc37 2022-10-23 stsp This path can be configured in
66 13b2bc37 2022-10-23 stsp .Xr gotd.conf 5 .
67 13b2bc37 2022-10-23 stsp .El
68 13b2bc37 2022-10-23 stsp .Sh SEE ALSO
69 13b2bc37 2022-10-23 stsp .Xr got 1 ,
70 13b2bc37 2022-10-23 stsp .Xr gotsh 1 ,
71 13b2bc37 2022-10-23 stsp .Xr git-repository 5 ,
72 13b2bc37 2022-10-23 stsp .Xr gotd.conf 5
73 13b2bc37 2022-10-23 stsp .Sh AUTHORS
74 13b2bc37 2022-10-23 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org