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 Sperling3 .\"4 .\" Permission to use, copy, modify, and distribute this software for any5 .\" purpose with or without fee is hereby granted, provided that the above6 .\" copyright notice and this permission notice appear in all copies.7 .\"8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.15 .\"16 .Dd $Mdocdate$17 .Dt GOTSH 118 .Os19 .Sh NAME20 .Nm gotsh21 .Nd Game of Trees Shell22 .Sh SYNOPSIS23 .Nm Fl c Sq Cm git-receive-pack Ar repository-path24 .Nm Fl c Sq Cm git-upload-pack Ar repository-path25 .Sh DESCRIPTION26 .Nm27 is the network-facing interface to28 .Xr gotd 8 .29 It implements the server-side part of the Git network protocol used by30 .Xr git 131 and32 .Xr got 1 .33 .Pp34 .Nm35 is not an interactive shell.36 .Nm37 is intended to be configured as the login shell of Git repository38 user accounts on servers running39 .Xr gotd 8 .40 The users can then interact with41 .Xr gotd 842 over the network.43 When users invoke commands such as44 .Cm got send45 and46 .Cm got fetch47 on client machines,48 .Xr got 149 will connect to the server with50 .Xr ssh 1 .51 .Nm52 will facilitate communication between53 .Xr gotd 854 running on the server machine and the55 .Xr got 156 or57 .Xr git 158 program running on the client machine.59 .Pp60 Users running61 .Nm62 must be members of the group which has read/write permission to the63 .Xr gotd 864 unix socket.65 The group used for this purpose can be configured in66 .Xr gotd.conf 5 .67 Users running68 .Nm69 should not have access to Git repositories by means other than70 accessing the unix socket of71 .Xr gotd 872 via73 .Nm .74 .Pp75 It is recommended to restrict76 .Xr ssh 177 features available to users of78 .Nm .79 See the EXAMPLES section for details.80 .Sh ENVIRONMENT81 .Bl -tag -width GOTD_UNIX_SOCKET82 .It Ev GOTD_UNIX_SOCKET83 Set the path to the unix socket which84 .Xr gotd 885 is listening on.86 If not specified, the default path87 .Pa /var/run/gotd.sock88 will be used.89 .El90 .Sh EXAMPLES91 The following92 .Xr sshd_config 593 directives are recommended to protect the server machine and any systems94 reachable from it via95 .Xr ssh 196 forwarding features.97 This example assumes the group called98 .Dq _gotsh99 has read/write access to the100 .Xr gotd 8101 unix socket.102 .Bd -literal -offset indent103 Match Group _gotsh104 DisableForwarding105 PermitTTY no106 .Sh SEE ALSO107 .Xr got 1 ,108 .Xr ssh 1 ,109 .Xr gotd.conf 5 ,110 .Xr sshd_config 5 ,111 .Xr gotd 8112 .Sh AUTHORS113 .An Stefan Sperling Aq Mt stsp@openbsd.org