2 f1752522 2022-10-29 stsp * Copyright (c) 2022 Stefan Sperling <stsp@openbsd.org>
4 f1752522 2022-10-29 stsp * Permission to use, copy, modify, and distribute this software for any
5 f1752522 2022-10-29 stsp * purpose with or without fee is hereby granted, provided that the above
6 f1752522 2022-10-29 stsp * copyright notice and this permission notice appear in all copies.
8 f1752522 2022-10-29 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 f1752522 2022-10-29 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 f1752522 2022-10-29 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 f1752522 2022-10-29 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 f1752522 2022-10-29 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 f1752522 2022-10-29 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 f1752522 2022-10-29 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 f1752522 2022-10-29 stsp #include <sys/queue.h>
18 f1752522 2022-10-29 stsp #include <sys/socket.h>
19 f1752522 2022-10-29 stsp #include <sys/un.h>
21 f1752522 2022-10-29 stsp #include <err.h>
22 f1752522 2022-10-29 stsp #include <event.h>
23 f1752522 2022-10-29 stsp #include <imsg.h>
24 f1752522 2022-10-29 stsp #include <limits.h>
25 f1752522 2022-10-29 stsp #include <locale.h>
26 f1752522 2022-10-29 stsp #include <sha1.h>
27 f1752522 2022-10-29 stsp #include <stdio.h>
28 f1752522 2022-10-29 stsp #include <stdlib.h>
29 f1752522 2022-10-29 stsp #include <string.h>
30 f1752522 2022-10-29 stsp #include <getopt.h>
31 f1752522 2022-10-29 stsp #include <unistd.h>
33 f1752522 2022-10-29 stsp #include "got_error.h"
34 f1752522 2022-10-29 stsp #include "got_version.h"
36 f1752522 2022-10-29 stsp #include "got_lib_gitproto.h"
38 f1752522 2022-10-29 stsp #include "gotd.h"
40 f1752522 2022-10-29 stsp #ifndef nitems
41 f1752522 2022-10-29 stsp #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
44 f1752522 2022-10-29 stsp #define GOTCTL_CMD_INFO "info"
45 f1752522 2022-10-29 stsp #define GOTCTL_CMD_STOP "stop"
47 f1752522 2022-10-29 stsp struct gotctl_cmd {
48 f1752522 2022-10-29 stsp const char *cmd_name;
49 f1752522 2022-10-29 stsp const struct got_error *(*cmd_main)(int, char *[], int);
50 f1752522 2022-10-29 stsp void (*cmd_usage)(void);
53 f1752522 2022-10-29 stsp __dead static void usage(int, int);
55 f1752522 2022-10-29 stsp __dead static void usage_info(void);
56 f1752522 2022-10-29 stsp __dead static void usage_stop(void);
58 f1752522 2022-10-29 stsp static const struct got_error* cmd_info(int, char *[], int);
59 f1752522 2022-10-29 stsp static const struct got_error* cmd_stop(int, char *[], int);
61 f1752522 2022-10-29 stsp static const struct gotctl_cmd gotctl_commands[] = {
62 f1752522 2022-10-29 stsp { "info", cmd_info, usage_info },
63 f1752522 2022-10-29 stsp { "stop", cmd_stop, usage_stop },
66 f1752522 2022-10-29 stsp __dead static void
67 f1752522 2022-10-29 stsp usage_info(void)
69 f1752522 2022-10-29 stsp fprintf(stderr, "usage: %s info\n", getprogname());
73 f1752522 2022-10-29 stsp static const struct got_error *
74 f1752522 2022-10-29 stsp show_info(struct imsg *imsg)
76 f1752522 2022-10-29 stsp struct gotd_imsg_info info;
77 f1752522 2022-10-29 stsp size_t datalen;
79 f1752522 2022-10-29 stsp datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
80 f1752522 2022-10-29 stsp if (datalen != sizeof(info))
81 f1752522 2022-10-29 stsp return got_error(GOT_ERR_PRIVSEP_LEN);
82 f1752522 2022-10-29 stsp memcpy(&info, imsg->data, sizeof(info));
84 f1752522 2022-10-29 stsp printf("gotd PID: %d\n", info.pid);
85 f1752522 2022-10-29 stsp printf("verbosity: %d\n", info.verbosity);
86 f1752522 2022-10-29 stsp printf("number of repositories: %d\n", info.nrepos);
87 f1752522 2022-10-29 stsp printf("number of connected clients: %d\n", info.nclients);
88 f1752522 2022-10-29 stsp return NULL;
91 f1752522 2022-10-29 stsp static const struct got_error *
92 f1752522 2022-10-29 stsp show_repo_info(struct imsg *imsg)
94 f1752522 2022-10-29 stsp struct gotd_imsg_info_repo info;
95 f1752522 2022-10-29 stsp size_t datalen;
97 f1752522 2022-10-29 stsp datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
98 f1752522 2022-10-29 stsp if (datalen != sizeof(info))
99 f1752522 2022-10-29 stsp return got_error(GOT_ERR_PRIVSEP_LEN);
100 f1752522 2022-10-29 stsp memcpy(&info, imsg->data, sizeof(info));
102 f1752522 2022-10-29 stsp printf("repository \"%s\", path %s\n", info.repo_name, info.repo_path);
103 f1752522 2022-10-29 stsp return NULL;
106 f1752522 2022-10-29 stsp static const char *
107 f1752522 2022-10-29 stsp get_state_name(enum gotd_client_state state)
109 f1752522 2022-10-29 stsp static char unknown_state[64];
111 f1752522 2022-10-29 stsp switch (state) {
112 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_LIST_REFS:
113 f1752522 2022-10-29 stsp return "list-refs";
114 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_CAPABILITIES:
115 f1752522 2022-10-29 stsp return "expect-capabilities";
116 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_WANT:
117 f1752522 2022-10-29 stsp return "expect-want";
118 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_REF_UPDATE:
119 f1752522 2022-10-29 stsp return "expect-ref-update";
120 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_MORE_REF_UPDATES:
121 f1752522 2022-10-29 stsp return "expect-more-ref-updates";
122 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_HAVE:
123 f1752522 2022-10-29 stsp return "expect-have";
124 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_PACKFILE:
125 f1752522 2022-10-29 stsp return "expect-packfile";
126 f1752522 2022-10-29 stsp case GOTD_STATE_EXPECT_DONE:
127 f1752522 2022-10-29 stsp return "expect-done";
128 f1752522 2022-10-29 stsp case GOTD_STATE_DONE:
129 f1752522 2022-10-29 stsp return "done";
132 f1752522 2022-10-29 stsp snprintf(unknown_state, sizeof(unknown_state),
133 f1752522 2022-10-29 stsp "unknown state %d", state);
134 f1752522 2022-10-29 stsp return unknown_state;
137 f1752522 2022-10-29 stsp static const struct got_error *
138 f1752522 2022-10-29 stsp show_client_info(struct imsg *imsg)
140 f1752522 2022-10-29 stsp struct gotd_imsg_info_client info;
141 f1752522 2022-10-29 stsp size_t datalen;
143 f1752522 2022-10-29 stsp datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
144 f1752522 2022-10-29 stsp if (datalen != sizeof(info))
145 f1752522 2022-10-29 stsp return got_error(GOT_ERR_PRIVSEP_LEN);
146 f1752522 2022-10-29 stsp memcpy(&info, imsg->data, sizeof(info));
148 f1752522 2022-10-29 stsp printf("client UID %d, GID %d, protocol state '%s', ",
149 f1752522 2022-10-29 stsp info.euid, info.egid, get_state_name(info.state));
150 ae7c1b78 2023-01-10 stsp if (info.session_child_pid)
151 ae7c1b78 2023-01-10 stsp printf("session PID %ld, ", (long)info.session_child_pid);
152 ae7c1b78 2023-01-10 stsp if (info.repo_child_pid)
153 ae7c1b78 2023-01-10 stsp printf("repo PID %ld, ", (long)info.repo_child_pid);
154 f1752522 2022-10-29 stsp if (info.is_writing)
155 f1752522 2022-10-29 stsp printf("writing to %s\n", info.repo_name);
157 f1752522 2022-10-29 stsp printf("reading from %s\n", info.repo_name);
159 f1752522 2022-10-29 stsp return NULL;
162 f1752522 2022-10-29 stsp static const struct got_error *
163 f1752522 2022-10-29 stsp show_capability(struct imsg *imsg)
165 f1752522 2022-10-29 stsp struct gotd_imsg_capability icapa;
166 f1752522 2022-10-29 stsp size_t datalen;
167 f1752522 2022-10-29 stsp char *key, *value = NULL;
169 f1752522 2022-10-29 stsp memset(&icapa, 0, sizeof(icapa));
171 f1752522 2022-10-29 stsp datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
172 f1752522 2022-10-29 stsp if (datalen < sizeof(icapa))
173 f1752522 2022-10-29 stsp return got_error(GOT_ERR_PRIVSEP_LEN);
174 f1752522 2022-10-29 stsp memcpy(&icapa, imsg->data, sizeof(icapa));
176 f1752522 2022-10-29 stsp if (datalen != sizeof(icapa) + icapa.key_len + icapa.value_len)
177 f1752522 2022-10-29 stsp return got_error(GOT_ERR_PRIVSEP_LEN);
179 f1752522 2022-10-29 stsp key = malloc(icapa.key_len + 1);
180 f1752522 2022-10-29 stsp if (key == NULL)
181 f1752522 2022-10-29 stsp return got_error_from_errno("malloc");
182 f1752522 2022-10-29 stsp if (icapa.value_len > 0) {
183 f1752522 2022-10-29 stsp value = malloc(icapa.value_len + 1);
184 f1752522 2022-10-29 stsp if (value == NULL) {
186 f1752522 2022-10-29 stsp return got_error_from_errno("malloc");
190 f1752522 2022-10-29 stsp memcpy(key, imsg->data + sizeof(icapa), icapa.key_len);
191 f1752522 2022-10-29 stsp key[icapa.key_len] = '\0';
192 f1752522 2022-10-29 stsp if (value) {
193 f1752522 2022-10-29 stsp memcpy(value, imsg->data + sizeof(icapa) + icapa.key_len,
194 f1752522 2022-10-29 stsp icapa.value_len);
195 f1752522 2022-10-29 stsp value[icapa.value_len] = '\0';
198 f1752522 2022-10-29 stsp if (strcmp(key, GOT_CAPA_AGENT) == 0)
199 f1752522 2022-10-29 stsp printf(" client user agent: %s\n", value);
200 f1752522 2022-10-29 stsp else if (value)
201 f1752522 2022-10-29 stsp printf(" client supports %s=%s\n", key, value);
203 f1752522 2022-10-29 stsp printf(" client supports %s\n", key);
206 f1752522 2022-10-29 stsp free(value);
207 f1752522 2022-10-29 stsp return NULL;
210 f1752522 2022-10-29 stsp static const struct got_error *
211 f1752522 2022-10-29 stsp cmd_info(int argc, char *argv[], int gotd_sock)
213 f1752522 2022-10-29 stsp const struct got_error *err;
214 f1752522 2022-10-29 stsp struct imsgbuf ibuf;
215 f1752522 2022-10-29 stsp struct imsg imsg;
217 f1752522 2022-10-29 stsp imsg_init(&ibuf, gotd_sock);
219 f1752522 2022-10-29 stsp if (imsg_compose(&ibuf, GOTD_IMSG_INFO, 0, 0, -1, NULL, 0) == -1)
220 f1752522 2022-10-29 stsp return got_error_from_errno("imsg_compose INFO");
222 f1752522 2022-10-29 stsp err = gotd_imsg_flush(&ibuf);
223 f1752522 2022-10-29 stsp while (err == NULL) {
224 f1752522 2022-10-29 stsp err = gotd_imsg_poll_recv(&imsg, &ibuf, 0);
226 f1752522 2022-10-29 stsp if (err->code == GOT_ERR_EOF)
227 f1752522 2022-10-29 stsp err = NULL;
231 f1752522 2022-10-29 stsp switch (imsg.hdr.type) {
232 f1752522 2022-10-29 stsp case GOTD_IMSG_ERROR:
233 f1752522 2022-10-29 stsp err = gotd_imsg_recv_error(NULL, &imsg);
235 f1752522 2022-10-29 stsp case GOTD_IMSG_INFO:
236 f1752522 2022-10-29 stsp err = show_info(&imsg);
238 f1752522 2022-10-29 stsp case GOTD_IMSG_INFO_REPO:
239 f1752522 2022-10-29 stsp err = show_repo_info(&imsg);
241 f1752522 2022-10-29 stsp case GOTD_IMSG_INFO_CLIENT:
242 f1752522 2022-10-29 stsp err = show_client_info(&imsg);
244 f1752522 2022-10-29 stsp case GOTD_IMSG_CAPABILITY:
245 f1752522 2022-10-29 stsp err = show_capability(&imsg);
248 f1752522 2022-10-29 stsp err = got_error(GOT_ERR_PRIVSEP_MSG);
252 f1752522 2022-10-29 stsp imsg_free(&imsg);
255 f1752522 2022-10-29 stsp imsg_clear(&ibuf);
256 f1752522 2022-10-29 stsp return err;
259 f1752522 2022-10-29 stsp __dead static void
260 f1752522 2022-10-29 stsp usage_stop(void)
262 f1752522 2022-10-29 stsp fprintf(stderr, "usage: %s stop\n", getprogname());
266 f1752522 2022-10-29 stsp static const struct got_error *
267 f1752522 2022-10-29 stsp cmd_stop(int argc, char *argv[], int gotd_sock)
269 f1752522 2022-10-29 stsp const struct got_error *err;
270 f1752522 2022-10-29 stsp struct imsgbuf ibuf;
271 f1752522 2022-10-29 stsp struct imsg imsg;
273 f1752522 2022-10-29 stsp imsg_init(&ibuf, gotd_sock);
275 f1752522 2022-10-29 stsp if (imsg_compose(&ibuf, GOTD_IMSG_STOP, 0, 0, -1, NULL, 0) == -1)
276 f1752522 2022-10-29 stsp return got_error_from_errno("imsg_compose STOP");
278 f1752522 2022-10-29 stsp err = gotd_imsg_flush(&ibuf);
279 f1752522 2022-10-29 stsp while (err == NULL) {
280 f1752522 2022-10-29 stsp err = gotd_imsg_poll_recv(&imsg, &ibuf, 0);
282 f1752522 2022-10-29 stsp if (err->code == GOT_ERR_EOF)
283 f1752522 2022-10-29 stsp err = NULL;
287 f1752522 2022-10-29 stsp switch (imsg.hdr.type) {
288 f1752522 2022-10-29 stsp case GOTD_IMSG_ERROR:
289 f1752522 2022-10-29 stsp err = gotd_imsg_recv_error(NULL, &imsg);
292 f1752522 2022-10-29 stsp err = got_error(GOT_ERR_PRIVSEP_MSG);
296 f1752522 2022-10-29 stsp imsg_free(&imsg);
299 f1752522 2022-10-29 stsp imsg_clear(&ibuf);
300 f1752522 2022-10-29 stsp return err;
303 f1752522 2022-10-29 stsp static void
304 f1752522 2022-10-29 stsp list_commands(FILE *fp)
308 f1752522 2022-10-29 stsp fprintf(fp, "commands:");
309 f1752522 2022-10-29 stsp for (i = 0; i < nitems(gotctl_commands); i++) {
310 f1752522 2022-10-29 stsp const struct gotctl_cmd *cmd = &gotctl_commands[i];
311 f1752522 2022-10-29 stsp fprintf(fp, " %s", cmd->cmd_name);
313 f1752522 2022-10-29 stsp fputc('\n', fp);
316 f1752522 2022-10-29 stsp __dead static void
317 f1752522 2022-10-29 stsp usage(int hflag, int status)
319 f1752522 2022-10-29 stsp FILE *fp = (status == 0) ? stdout : stderr;
321 a5a750bd 2022-11-14 op fprintf(fp, "usage: %s [-hV] [-f path] command [arg ...]\n",
322 f1752522 2022-10-29 stsp getprogname());
324 f1752522 2022-10-29 stsp list_commands(fp);
325 f1752522 2022-10-29 stsp exit(status);
328 f1752522 2022-10-29 stsp static const struct got_error *
329 f1752522 2022-10-29 stsp apply_unveil(const char *unix_socket_path)
331 f1752522 2022-10-29 stsp #ifdef PROFILE
332 f1752522 2022-10-29 stsp if (unveil("gmon.out", "rwc") != 0)
333 f1752522 2022-10-29 stsp return got_error_from_errno2("unveil", "gmon.out");
335 f1752522 2022-10-29 stsp if (unveil(unix_socket_path, "w") != 0)
336 f1752522 2022-10-29 stsp return got_error_from_errno2("unveil", unix_socket_path);
338 f1752522 2022-10-29 stsp if (unveil(NULL, NULL) != 0)
339 f1752522 2022-10-29 stsp return got_error_from_errno("unveil");
341 f1752522 2022-10-29 stsp return NULL;
345 f1752522 2022-10-29 stsp connect_gotd(const char *socket_path)
347 f1752522 2022-10-29 stsp const struct got_error *error = NULL;
348 f1752522 2022-10-29 stsp int gotd_sock = -1;
349 f1752522 2022-10-29 stsp struct sockaddr_un sun;
351 f5d30fbb 2022-10-29 op error = apply_unveil(socket_path);
353 f1752522 2022-10-29 stsp errx(1, "%s", error->msg);
355 f1752522 2022-10-29 stsp #ifndef PROFILE
356 f1752522 2022-10-29 stsp if (pledge("stdio unix", NULL) == -1)
357 f1752522 2022-10-29 stsp err(1, "pledge");
359 f1752522 2022-10-29 stsp if ((gotd_sock = socket(AF_UNIX, SOCK_STREAM, 0)) == -1)
360 f1752522 2022-10-29 stsp err(1, "socket");
362 f1752522 2022-10-29 stsp memset(&sun, 0, sizeof(sun));
363 f1752522 2022-10-29 stsp sun.sun_family = AF_UNIX;
364 f5d30fbb 2022-10-29 op if (strlcpy(sun.sun_path, socket_path, sizeof(sun.sun_path)) >=
365 f5d30fbb 2022-10-29 op sizeof(sun.sun_path))
366 f1752522 2022-10-29 stsp errx(1, "gotd socket path too long");
367 f1752522 2022-10-29 stsp if (connect(gotd_sock, (struct sockaddr *)&sun, sizeof(sun)) == -1)
368 f5d30fbb 2022-10-29 op err(1, "connect: %s", socket_path);
370 f1752522 2022-10-29 stsp #ifndef PROFILE
371 f1752522 2022-10-29 stsp if (pledge("stdio", NULL) == -1)
372 f1752522 2022-10-29 stsp err(1, "pledge");
375 f1752522 2022-10-29 stsp return gotd_sock;
379 f1752522 2022-10-29 stsp main(int argc, char *argv[])
381 f1752522 2022-10-29 stsp const struct gotctl_cmd *cmd;
382 f1752522 2022-10-29 stsp int gotd_sock = -1, i;
384 f1752522 2022-10-29 stsp int hflag = 0, Vflag = 0;
385 f1752522 2022-10-29 stsp static const struct option longopts[] = {
386 f1752522 2022-10-29 stsp { "version", no_argument, NULL, 'V' },
387 f1752522 2022-10-29 stsp { NULL, 0, NULL, 0 }
389 f5d30fbb 2022-10-29 op const char *socket_path = GOTD_UNIX_SOCKET;
391 f1752522 2022-10-29 stsp setlocale(LC_CTYPE, "");
393 f1752522 2022-10-29 stsp #ifndef PROFILE
394 f1752522 2022-10-29 stsp if (pledge("stdio unix unveil", NULL) == -1)
395 f1752522 2022-10-29 stsp err(1, "pledge");
398 f1752522 2022-10-29 stsp while ((ch = getopt_long(argc, argv, "+hf:V", longopts, NULL)) != -1) {
399 f1752522 2022-10-29 stsp switch (ch) {
404 f1752522 2022-10-29 stsp socket_path = optarg;
410 f1752522 2022-10-29 stsp usage(hflag, 1);
411 f1752522 2022-10-29 stsp /* NOTREACHED */
415 f1752522 2022-10-29 stsp argc -= optind;
416 f1752522 2022-10-29 stsp argv += optind;
417 f1752522 2022-10-29 stsp optind = 1;
418 f1752522 2022-10-29 stsp optreset = 1;
420 f1752522 2022-10-29 stsp if (Vflag) {
421 f1752522 2022-10-29 stsp got_version_print_str();
425 f1752522 2022-10-29 stsp if (argc <= 0)
426 f1752522 2022-10-29 stsp usage(hflag, hflag ? 0 : 1);
428 f1752522 2022-10-29 stsp for (i = 0; i < nitems(gotctl_commands); i++) {
429 f1752522 2022-10-29 stsp const struct got_error *error;
431 f1752522 2022-10-29 stsp cmd = &gotctl_commands[i];
433 f1752522 2022-10-29 stsp if (strncmp(cmd->cmd_name, argv[0], strlen(argv[0])) != 0)
437 f1752522 2022-10-29 stsp cmd->cmd_usage();
439 f1752522 2022-10-29 stsp gotd_sock = connect_gotd(socket_path);
440 f1752522 2022-10-29 stsp if (gotd_sock == -1)
442 f1752522 2022-10-29 stsp error = cmd->cmd_main(argc, argv, gotd_sock);
443 f1752522 2022-10-29 stsp close(gotd_sock);
444 f1752522 2022-10-29 stsp if (error) {
445 f1752522 2022-10-29 stsp fprintf(stderr, "%s: %s\n", getprogname(), error->msg);
452 f1752522 2022-10-29 stsp fprintf(stderr, "%s: unknown command '%s'\n", getprogname(), argv[0]);
453 f1752522 2022-10-29 stsp list_commands(stderr);