Blob

Date:
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 | Blame | Raw File
1 .\"

2 .\" Copyright (c) 2022 Stefan Sperling

3 .\"

4 .\" Permission to use, copy, modify, and distribute this software for any

5 .\" purpose with or without fee is hereby granted, provided that the above

6 .\" copyright notice and this permission notice appear in all copies.

7 .\"

8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

15 .\"

16 .Dd $Mdocdate$

17 .Dt GOTD 8

18 .Os

19 .Sh NAME

20 .Nm gotd

21 .Nd Game of Trees Daemon

22 .Sh SYNOPSIS

23 .Nm

24 .Op Fl dv

25 .Op Fl f Ar config-file

26 .Sh DESCRIPTION

27 .Nm

28 is a Git repository server which listens on a

29 .Xr unix 4

30 socket and relies on its companion tool

31 .Xr gotsh 1

32 to handle Git-protocol communication over the network, via

33 .Xr ssh 1 .

34 .Pp

35 The Git repository format is described in

36 .Xr git-repository 5 .

37 .Pp

38 .Nm

39 requires a configuration file in order to run.

40 The configuration file format is described in

41 .Xr gotd.conf 5 .

42 .Pp

43 The options for

44 .Nm

45 are as follows:

46 .Bl -tag -width Ds

47 .It Fl d

48 Do not daemonize and log to stderr.

49 .It Fl f Ar config-file

50 Set the path to the configuration file.

51 If not specified, the file

52 .Pa /etc/gotd.conf

53 will be used.

54 .It Fl v

55 Verbose mode.

56 Verbosity increases if this option is used multiple times.

57 .Sh FILES

58 .Bl -tag -width Ds -compact

59 .It Pa /etc/gotd.conf

60 Default location of the configuration file.

61 .It Pa /var/run/gotd.sock

62 Default location of the unix socket which

63 .Nm

64 is listening on.

65 This path can be configured in

66 .Xr gotd.conf 5 .

67 .El

68 .Sh SEE ALSO

69 .Xr got 1 ,

70 .Xr gotsh 1 ,

71 .Xr git-repository 5 ,

72 .Xr gotd.conf 5

73 .Sh AUTHORS

74 .An Stefan Sperling Aq Mt stsp@openbsd.org