Gotweb

Blame

Date:: Sat Mar 30 17:17:56 2024 UTC
Message:: add initial support for commit notifications to gotd(8) At present only email notifications are implemented. Code for HTTP notifications is not yet finished, hence HTTP-related documentation remains hidden for now. This adds a new 'notify' process which has an "exec" pledge. It runs helper programs which implement the notification transport layer, such as got-notify-email which speaks SMTP. This design avoids having to link all of gotd with network libraries and related crypto libraries. Notification content is generated by the 'repo_write' process. Commit log messages and diffstats are written to a file which the 'notify' process will pass on to its helpers on stdin. The default output looks similar to 'got log -d'. If too many new commits are present the output looks similar to 'got log -s' instead. Tags always look like 'got tag -l'. The session process coordinates generation of notifications. It maintains a notification queue which holds one notification per updated reference, and passes notification requests from this queue to the 'repo_write' process for notification content creation and then to the 'notify' process for notification delivery. Only one notification can be in flight at a time to avoid file descriptor starvation if many references get updated in a single client session. ok op@
Actions:: History | Blob | Raw File

  1 5dcb3a43 2023-04-01 thomas /*
  2 5dcb3a43 2023-04-01 thomas  * Copyright (c) 2023 Stefan Sperling <stsp@openbsd.org>
  3 5dcb3a43 2023-04-01 thomas  *
  4 5dcb3a43 2023-04-01 thomas  * Permission to use, copy, modify, and distribute this software for any
  5 5dcb3a43 2023-04-01 thomas  * purpose with or without fee is hereby granted, provided that the above
  6 5dcb3a43 2023-04-01 thomas  * copyright notice and this permission notice appear in all copies.
  7 5dcb3a43 2023-04-01 thomas  *
  8 5dcb3a43 2023-04-01 thomas  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9 5dcb3a43 2023-04-01 thomas  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 10 5dcb3a43 2023-04-01 thomas  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 11 5dcb3a43 2023-04-01 thomas  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 12 5dcb3a43 2023-04-01 thomas  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 13 5dcb3a43 2023-04-01 thomas  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 14 5dcb3a43 2023-04-01 thomas  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 15 5dcb3a43 2023-04-01 thomas  */
 16 5dcb3a43 2023-04-01 thomas 
 17 5dcb3a43 2023-04-01 thomas /*
 18 5dcb3a43 2023-04-01 thomas  * Resolve path namespace conflicts for git-upload-pack and git-receive-pack.
 19 5dcb3a43 2023-04-01 thomas  */
 20 5dcb3a43 2023-04-01 thomas 
 21 4efc8dcb 2023-08-29 thomas #include "got_compat.h"
 22 4efc8dcb 2023-08-29 thomas 
 23 5dcb3a43 2023-04-01 thomas #include <sys/queue.h>
 24 5dcb3a43 2023-04-01 thomas #include <sys/types.h>
 25 5dcb3a43 2023-04-01 thomas #include <sys/uio.h>
 26 5dcb3a43 2023-04-01 thomas 
 27 5dcb3a43 2023-04-01 thomas #include <err.h>
 28 5dcb3a43 2023-04-01 thomas #include <errno.h>
 29 5dcb3a43 2023-04-01 thomas #include <event.h>
 30 5dcb3a43 2023-04-01 thomas #include <limits.h>
 31 5dcb3a43 2023-04-01 thomas #include <stdio.h>
 32 5dcb3a43 2023-04-01 thomas #include <stdlib.h>
 33 5dcb3a43 2023-04-01 thomas #include <string.h>
 34 5dcb3a43 2023-04-01 thomas #include <syslog.h>
 35 5dcb3a43 2023-04-01 thomas #include <unistd.h>
 36 5dcb3a43 2023-04-01 thomas 
 37 5dcb3a43 2023-04-01 thomas #include "got_error.h"
 38 5dcb3a43 2023-04-01 thomas #include "got_path.h"
 39 5dcb3a43 2023-04-01 thomas 
 40 5769f9a0 2023-04-22 thomas #include "got_lib_dial.h"
 41 5769f9a0 2023-04-22 thomas 
 42 5dcb3a43 2023-04-01 thomas #include "gotd.h"
 43 5dcb3a43 2023-04-01 thomas #include "log.h"
 44 5dcb3a43 2023-04-01 thomas 
 45 5dcb3a43 2023-04-01 thomas #ifndef GITWRAPPER_GIT_LIBEXEC_DIR
 46 5dcb3a43 2023-04-01 thomas #define GITWRAPPER_GIT_LIBEXEC_DIR "/usr/local/libexec/git"
 47 5dcb3a43 2023-04-01 thomas #endif
 48 5dcb3a43 2023-04-01 thomas 
 49 5dcb3a43 2023-04-01 thomas #ifndef GITWRAPPER_MY_SERVER_PROG
 50 5dcb3a43 2023-04-01 thomas #define GITWRAPPER_MY_SERVER_PROG "gotsh"
 51 5dcb3a43 2023-04-01 thomas #endif
 52 5dcb3a43 2023-04-01 thomas 
 53 5dcb3a43 2023-04-01 thomas 
 54 5dcb3a43 2023-04-01 thomas __dead static void
 55 5dcb3a43 2023-04-01 thomas usage(void)
 56 5dcb3a43 2023-04-01 thomas {
 57 5dcb3a43 2023-04-01 thomas 	fprintf(stderr, "usage: %s -c '%s|%s repository-path'\n",
 58 5769f9a0 2023-04-22 thomas 	    getprogname(), GOT_DIAL_CMD_SEND, GOT_DIAL_CMD_FETCH);
 59 5dcb3a43 2023-04-01 thomas 	exit(1);
 60 5dcb3a43 2023-04-01 thomas }
 61 5dcb3a43 2023-04-01 thomas 
 62 5dcb3a43 2023-04-01 thomas /*
 63 5dcb3a43 2023-04-01 thomas  * Unveil the specific programs we want to start and hide everything else.
 64 5dcb3a43 2023-04-01 thomas  * This is important to limit the impact of our "exec" pledge.
 65 5dcb3a43 2023-04-01 thomas  */
 66 5dcb3a43 2023-04-01 thomas static const struct got_error *
 67 5dcb3a43 2023-04-01 thomas apply_unveil(const char *myserver)
 68 5dcb3a43 2023-04-01 thomas {
 69 5dcb3a43 2023-04-01 thomas 	const char *fetchcmd = GITWRAPPER_GIT_LIBEXEC_DIR "/" \
 70 5769f9a0 2023-04-22 thomas 		GOT_DIAL_CMD_FETCH;
 71 5dcb3a43 2023-04-01 thomas 	const char *sendcmd = GITWRAPPER_GIT_LIBEXEC_DIR "/" \
 72 5769f9a0 2023-04-22 thomas 		GOT_DIAL_CMD_SEND;
 73 5dcb3a43 2023-04-01 thomas 
 74 5dcb3a43 2023-04-01 thomas #ifdef PROFILE
 75 5dcb3a43 2023-04-01 thomas 	if (unveil("gmon.out", "rwc") != 0)
 76 5dcb3a43 2023-04-01 thomas 		return got_error_from_errno2("unveil", "gmon.out");
 77 5dcb3a43 2023-04-01 thomas #endif
 78 768236a0 2023-05-26 thomas 	if (unveil(fetchcmd, "x") != 0 && errno != ENOENT)
 79 5dcb3a43 2023-04-01 thomas 		return got_error_from_errno2("unveil", fetchcmd);
 80 5dcb3a43 2023-04-01 thomas 
 81 768236a0 2023-05-26 thomas 	if (unveil(sendcmd, "x") != 0 && errno != ENOENT)
 82 5dcb3a43 2023-04-01 thomas 		return got_error_from_errno2("unveil", sendcmd);
 83 5dcb3a43 2023-04-01 thomas 
 84 768236a0 2023-05-26 thomas 	if (myserver && unveil(myserver, "x") != 0 && errno != ENOENT)
 85 5dcb3a43 2023-04-01 thomas 		return got_error_from_errno2("unveil", myserver);
 86 5dcb3a43 2023-04-01 thomas 
 87 5dcb3a43 2023-04-01 thomas 	if (unveil(NULL, NULL) != 0)
 88 5dcb3a43 2023-04-01 thomas 		return got_error_from_errno("unveil");
 89 5dcb3a43 2023-04-01 thomas 
 90 5dcb3a43 2023-04-01 thomas 	return NULL;
 91 5dcb3a43 2023-04-01 thomas }
 92 5dcb3a43 2023-04-01 thomas 
 93 5dcb3a43 2023-04-01 thomas int
 94 5dcb3a43 2023-04-01 thomas main(int argc, char *argv[])
 95 5dcb3a43 2023-04-01 thomas {
 96 5dcb3a43 2023-04-01 thomas 	const struct got_error *error;
 97 5dcb3a43 2023-04-01 thomas 	const char *confpath = NULL;
 98 5dcb3a43 2023-04-01 thomas 	char *command = NULL, *repo_name = NULL; /* for matching gotd.conf */
 99 5dcb3a43 2023-04-01 thomas 	char *myserver = NULL;
100 5dcb3a43 2023-04-01 thomas 	const char *repo_path = NULL; /* as passed on the command line */
101 5dcb3a43 2023-04-01 thomas 	const char *relpath;
102 5dcb3a43 2023-04-01 thomas 	char *gitcommand = NULL;
103 5dcb3a43 2023-04-01 thomas 	struct gotd gotd;
104 5dcb3a43 2023-04-01 thomas 	struct gotd_repo *repo = NULL;
105 5dcb3a43 2023-04-01 thomas 
106 5dcb3a43 2023-04-01 thomas 	log_init(1, LOG_USER); /* Log to stderr. */
107 5dcb3a43 2023-04-01 thomas 
108 5dcb3a43 2023-04-01 thomas #ifndef PROFILE
109 44e35bfc 2023-04-01 thomas 	if (pledge("stdio rpath exec unveil", NULL) == -1)
110 5dcb3a43 2023-04-01 thomas 		err(1, "pledge");
111 5dcb3a43 2023-04-01 thomas #endif
112 5dcb3a43 2023-04-01 thomas 
113 5dcb3a43 2023-04-01 thomas 	/*
114 5dcb3a43 2023-04-01 thomas 	 * Look up our own server program in PATH so we can unveil(2) it.
115 5dcb3a43 2023-04-01 thomas 	 * This call only errors out upon memory allocation failure.
116 5dcb3a43 2023-04-01 thomas 	 * If the program cannot be found then myserver will be set to NULL.
117 5dcb3a43 2023-04-01 thomas 	 */
118 5dcb3a43 2023-04-01 thomas 	error = got_path_find_prog(&myserver, GITWRAPPER_MY_SERVER_PROG);
119 5dcb3a43 2023-04-01 thomas 	if (error)
120 5dcb3a43 2023-04-01 thomas 		goto done;
121 5dcb3a43 2023-04-01 thomas 
122 5dcb3a43 2023-04-01 thomas 	/*
123 5dcb3a43 2023-04-01 thomas 	 * Run parse_config() before unveil(2) because parse_config()
124 5dcb3a43 2023-04-01 thomas 	 * checks whether repository paths exist on disk.
125 5dcb3a43 2023-04-01 thomas 	 * Parsing errors and warnings will be logged to stderr.
126 5dcb3a43 2023-04-01 thomas 	 * Upon failure we will run Git's native tooling so do not
127 5dcb3a43 2023-04-01 thomas 	 * bother checking for errors here.
128 5dcb3a43 2023-04-01 thomas 	 */
129 5dcb3a43 2023-04-01 thomas 	confpath = getenv("GOTD_CONF_PATH");
130 5dcb3a43 2023-04-01 thomas 	if (confpath == NULL)
131 5dcb3a43 2023-04-01 thomas 		confpath = GOTD_CONF_PATH;
132 f3807fe5 2023-07-10 thomas 	parse_config(confpath, PROC_GITWRAPPER, &gotd);
133 5dcb3a43 2023-04-01 thomas 
134 5dcb3a43 2023-04-01 thomas 	error = apply_unveil(myserver);
135 5dcb3a43 2023-04-01 thomas 	if (error)
136 5dcb3a43 2023-04-01 thomas 		goto done;
137 5dcb3a43 2023-04-01 thomas 
138 5dcb3a43 2023-04-01 thomas #ifndef PROFILE
139 44e35bfc 2023-04-01 thomas 	if (pledge("stdio exec", NULL) == -1)
140 5dcb3a43 2023-04-01 thomas 		err(1, "pledge");
141 5dcb3a43 2023-04-01 thomas #endif
142 5dcb3a43 2023-04-01 thomas 
143 5769f9a0 2023-04-22 thomas 	if (strcmp(getprogname(), GOT_DIAL_CMD_SEND) == 0 ||
144 5769f9a0 2023-04-22 thomas 	    strcmp(getprogname(), GOT_DIAL_CMD_FETCH) == 0) {
145 5dcb3a43 2023-04-01 thomas 		if (argc != 2)
146 5dcb3a43 2023-04-01 thomas 			usage();
147 5dcb3a43 2023-04-01 thomas 		command = strdup(getprogname());
148 5dcb3a43 2023-04-01 thomas 		if (command == NULL) {
149 5dcb3a43 2023-04-01 thomas 			error = got_error_from_errno("strdup");
150 5dcb3a43 2023-04-01 thomas 			goto done;
151 5dcb3a43 2023-04-01 thomas 		}
152 5dcb3a43 2023-04-01 thomas 		repo_path = argv[1];
153 5dcb3a43 2023-04-01 thomas 		relpath = argv[1];
154 5dcb3a43 2023-04-01 thomas 		while (relpath[0] == '/')
155 5dcb3a43 2023-04-01 thomas 			relpath++;
156 5dcb3a43 2023-04-01 thomas 		repo_name = strdup(relpath);
157 5dcb3a43 2023-04-01 thomas 		if (repo_name == NULL) {
158 5dcb3a43 2023-04-01 thomas 			error = got_error_from_errno("strdup");
159 5dcb3a43 2023-04-01 thomas 			goto done;
160 5dcb3a43 2023-04-01 thomas 		}
161 5dcb3a43 2023-04-01 thomas 	} else {
162 5dcb3a43 2023-04-01 thomas 		if (argc != 3 || strcmp(argv[1], "-c") != 0)
163 5dcb3a43 2023-04-01 thomas 			usage();
164 5dcb3a43 2023-04-01 thomas 		repo_path = argv[2];
165 5769f9a0 2023-04-22 thomas 		error = got_dial_parse_command(&command, &repo_name,
166 5dcb3a43 2023-04-01 thomas 		    repo_path);
167 5dcb3a43 2023-04-01 thomas 		if (error && error->code == GOT_ERR_BAD_PACKET)
168 5dcb3a43 2023-04-01 thomas 			usage();
169 5dcb3a43 2023-04-01 thomas 		if (error)
170 5dcb3a43 2023-04-01 thomas 			goto done;
171 5dcb3a43 2023-04-01 thomas 	}
172 5dcb3a43 2023-04-01 thomas 
173 ce1bfad9 2024-03-30 thomas 	repo = gotd_find_repo_by_name(repo_name, &gotd.repos);
174 5dcb3a43 2023-04-01 thomas 
175 5dcb3a43 2023-04-01 thomas 	/*
176 9c9f0ee1 2023-04-01 thomas 	 * Invoke our custom Git server if the repository was found
177 9c9f0ee1 2023-04-01 thomas 	 * in gotd.conf. Otherwise invoke native git(1) tooling.
178 5dcb3a43 2023-04-01 thomas 	 */
179 44e35bfc 2023-04-01 thomas 	if (repo) {
180 44e35bfc 2023-04-01 thomas 		if (myserver == NULL) {
181 44e35bfc 2023-04-01 thomas 			error = got_error_fmt(GOT_ERR_NO_PROG,
182 44e35bfc 2023-04-01 thomas 			    "cannot run '%s'",
183 44e35bfc 2023-04-01 thomas 			    GITWRAPPER_MY_SERVER_PROG);
184 44e35bfc 2023-04-01 thomas 			goto done;
185 5dcb3a43 2023-04-01 thomas 		}
186 44e35bfc 2023-04-01 thomas 		execl(myserver, command, repo_name, (char *)NULL);
187 44e35bfc 2023-04-01 thomas 		error = got_error_from_errno2("execl", myserver);
188 44e35bfc 2023-04-01 thomas 	} else {
189 44e35bfc 2023-04-01 thomas 		if (asprintf(&gitcommand, "%s/%s",
190 44e35bfc 2023-04-01 thomas 		    GITWRAPPER_GIT_LIBEXEC_DIR, command) == -1) {
191 44e35bfc 2023-04-01 thomas 			error = got_error_from_errno("asprintf");
192 44e35bfc 2023-04-01 thomas 			goto done;
193 44e35bfc 2023-04-01 thomas 		}
194 44e35bfc 2023-04-01 thomas 		execl(gitcommand, gitcommand, repo_path, (char *)NULL);
195 44e35bfc 2023-04-01 thomas 		error = got_error_from_errno2("execl", gitcommand);
196 5dcb3a43 2023-04-01 thomas 	}
197 5dcb3a43 2023-04-01 thomas 
198 5dcb3a43 2023-04-01 thomas done:
199 5dcb3a43 2023-04-01 thomas 	free(command);
200 5dcb3a43 2023-04-01 thomas 	free(repo_name);
201 5dcb3a43 2023-04-01 thomas 	free(myserver);
202 5dcb3a43 2023-04-01 thomas 	free(gitcommand);
203 5dcb3a43 2023-04-01 thomas 	if (error) {
204 5dcb3a43 2023-04-01 thomas 		fprintf(stderr, "%s: %s\n", getprogname(), error->msg);
205 5dcb3a43 2023-04-01 thomas 		return 1;
206 5dcb3a43 2023-04-01 thomas 	}
207 5dcb3a43 2023-04-01 thomas 
208 5dcb3a43 2023-04-01 thomas 	return 0;
209 5dcb3a43 2023-04-01 thomas }