2 * Copyright (c) 2022 Stefan Sperling <stsp@openbsd.org>
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.
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.
17 #include "got_compat.h"
19 #define GOTD_UNIX_SOCKET "/var/run/gotd.sock"
20 #define GOTD_UNIX_SOCKET_BACKLOG 10
21 #define GOTD_USER "_gotd"
22 #define GOTD_CONF_PATH "/etc/gotd.conf"
23 #ifndef GOTD_EMPTY_PATH
24 #define GOTD_EMPTY_PATH "/var/empty"
27 #ifndef GOT_LIBEXECDIR
28 #define GOT_LIBEXECDIR /usr/libexec
31 #define GOTD_STRINGIFY(x) #x
32 #define GOTD_STRINGVAL(x) GOTD_STRINGIFY(x)
34 #define GOTD_PROG_NOTIFY_EMAIL got-notify-email
35 #define GOTD_PROG_NOTIFY_HTTP got-notify-http
37 #define GOTD_PATH_PROG_NOTIFY_EMAIL \
38 GOTD_STRINGVAL(GOT_LIBEXECDIR) "/" \
39 GOTD_STRINGVAL(GOTD_PROG_NOTIFY_EMAIL)
40 #define GOTD_PATH_PROG_NOTIFY_HTTP \
41 GOTD_STRINGVAL(GOT_LIBEXECDIR) "/" \
42 GOTD_STRINGVAL(GOTD_PROG_NOTIFY_HTTP)
44 #define GOTD_MAXCLIENTS 1024
45 #define GOTD_MAX_CONN_PER_UID 4
46 #define GOTD_FD_RESERVE 5
47 #define GOTD_FD_NEEDED 6
48 #define GOTD_FILENO_MSG_PIPE 3
50 #define GOTD_DEFAULT_REQUEST_TIMEOUT 3600
52 /* Client hash tables need some extra room. */
53 #define GOTD_CLIENT_TABLE_SIZE (GOTD_MAXCLIENTS * 4)
70 void (*handler)(int, short, void *);
77 GOTD_ACCESS_PERMITTED = 1,
81 struct gotd_access_rule {
82 STAILQ_ENTRY(gotd_access_rule) entry;
84 enum gotd_access access;
87 #define GOTD_AUTH_READ 0x1
88 #define GOTD_AUTH_WRITE 0x2
92 STAILQ_HEAD(gotd_access_rule_list, gotd_access_rule);
94 enum gotd_notification_target_type {
95 GOTD_NOTIFICATION_VIA_EMAIL,
96 GOTD_NOTIFICATION_VIA_HTTP
99 struct gotd_notification_target {
100 STAILQ_ENTRY(gotd_notification_target) entry;
102 enum gotd_notification_target_type type;
118 STAILQ_HEAD(gotd_notification_targets, gotd_notification_target);
121 TAILQ_ENTRY(gotd_repo) entry;
126 struct gotd_access_rule_list rules;
127 struct got_pathlist_head protected_tag_namespaces;
128 struct got_pathlist_head protected_branch_namespaces;
129 struct got_pathlist_head protected_branches;
131 struct got_pathlist_head notification_refs;
132 struct got_pathlist_head notification_ref_namespaces;
133 struct gotd_notification_targets notification_targets;
135 TAILQ_HEAD(gotd_repolist, gotd_repo);
137 enum gotd_session_state {
138 GOTD_STATE_EXPECT_LIST_REFS,
139 GOTD_STATE_EXPECT_CAPABILITIES,
140 GOTD_STATE_EXPECT_WANT,
141 GOTD_STATE_EXPECT_REF_UPDATE,
142 GOTD_STATE_EXPECT_MORE_REF_UPDATES,
143 GOTD_STATE_EXPECT_HAVE,
144 GOTD_STATE_EXPECT_PACKFILE,
145 GOTD_STATE_EXPECT_DONE,
150 struct gotd_client_capability {
155 struct gotd_object_id_array {
156 struct got_object_id **ids;
161 struct gotd_uid_connection_limit {
166 struct gotd_child_proc;
170 char unix_socket_path[PATH_MAX];
172 struct gotd_repolist repos;
174 struct gotd_child_proc *listen_proc;
175 struct gotd_child_proc *notify_proc;
176 int notifications_enabled;
177 struct timeval request_timeout;
178 struct timeval auth_timeout;
179 struct gotd_uid_connection_limit *connection_limits;
180 size_t nconnection_limits;
183 const char *confpath;
188 enum gotd_imsg_type {
189 /* An error occured while processing a request. */
192 /* Commands used by gotctl(8). */
195 GOTD_IMSG_INFO_CLIENT,
198 /* Request a list of references. */
200 GOTD_IMSG_LIST_REFS_INTERNAL,
207 /* Git protocol capabilities. */
208 GOTD_IMSG_CAPABILITIES,
209 GOTD_IMSG_CAPABILITY,
211 /* Git protocol chatter. */
212 GOTD_IMSG_WANT, /* The client wants an object. */
213 GOTD_IMSG_HAVE, /* The client has an object. */
214 GOTD_IMSG_ACK, /* The server has an object or a reference. */
215 GOTD_IMSG_NAK, /* The server does not have an object/ref. */
216 GOTD_IMSG_REF_UPDATE, /* The client wants to update a reference. */
217 GOTD_IMSG_REF_DELETE, /* The client wants to delete a reference. */
218 GOTD_IMSG_FLUSH, /* The client sent a flush packet. */
219 GOTD_IMSG_DONE, /* The client is done chatting. */
221 /* Sending or receiving a pack file. */
222 GOTD_IMSG_SEND_PACKFILE, /* The server is sending a pack file. */
223 GOTD_IMSG_RECV_PACKFILE, /* The server is receiving a pack file. */
224 GOTD_IMSG_PACKIDX_FILE, /* Temporary file handle for new pack index. */
225 GOTD_IMSG_PACKFILE_PIPE, /* Pipe to send/receive a pack file stream. */
226 GOTD_IMSG_PACKFILE_PROGRESS, /* Progress reporting. */
227 GOTD_IMSG_PACKFILE_READY, /* Pack file is ready to be sent. */
228 GOTD_IMSG_PACKFILE_STATUS, /* Received pack success/failure status. */
229 GOTD_IMSG_PACKFILE_INSTALL, /* Received pack file can be installed. */
230 GOTD_IMSG_PACKFILE_DONE, /* Pack file has been sent/received. */
232 /* Reference updates. */
233 GOTD_IMSG_REF_UPDATES_START, /* Ref updates starting. */
234 GOTD_IMSG_REF_UPDATE_OK, /* Update went OK. */
235 GOTD_IMSG_REF_UPDATE_NG, /* Update was not good. */
236 GOTD_IMSG_REFS_UPDATED, /* The server proccessed all ref updates. */
238 /* Client connections. */
239 GOTD_IMSG_DISCONNECT,
242 /* Child process management. */
243 GOTD_IMSG_CLIENT_SESSION_READY,
244 GOTD_IMSG_REPO_CHILD_READY,
245 GOTD_IMSG_CONNECT_REPO_CHILD,
247 /* Auth child process. */
248 GOTD_IMSG_AUTHENTICATE,
249 GOTD_IMSG_ACCESS_GRANTED,
251 /* Notify child process. */
252 GOTD_IMSG_CONNECT_NOTIFIER,
253 GOTD_IMSG_CONNECT_SESSION,
255 GOTD_IMSG_NOTIFICATION_SENT
258 /* Structure for GOTD_IMSG_ERROR. */
259 struct gotd_imsg_error {
260 int code; /* an error code from got_error.h */
261 int errno_code; /* in case code equals GOT_ERR_ERRNO */
263 char msg[GOT_ERR_MAX_MSG_SIZE];
264 } __attribute__((__packed__));
266 /* Structure for GOTD_IMSG_INFO. */
267 struct gotd_imsg_info {
273 /* Followed by nrepos GOTD_IMSG_INFO_REPO messages. */
274 /* Followed by nclients GOTD_IMSG_INFO_CLIENT messages. */
277 /* Structure for GOTD_IMSG_INFO_REPO. */
278 struct gotd_imsg_info_repo {
279 char repo_name[NAME_MAX];
280 char repo_path[PATH_MAX];
283 /* Structure for GOTD_IMSG_INFO_CLIENT */
284 struct gotd_imsg_info_client {
287 char repo_name[NAME_MAX];
289 pid_t session_child_pid;
290 pid_t repo_child_pid;
293 /* Structure for GOTD_IMSG_LIST_REFS. */
294 struct gotd_imsg_list_refs {
295 char repo_name[NAME_MAX];
296 int client_is_reading; /* 1 if reading, 0 if writing */
299 /* Structure for GOTD_IMSG_LIST_REFS_INTERNAL. */
300 struct gotd_imsg_list_refs_internal {
304 /* Structure for GOTD_IMSG_REFLIST. */
305 struct gotd_imsg_reflist {
308 /* Followed by nrefs times of gotd_imsg_ref/gotd_imsg_symref data. */
309 } __attribute__((__packed__));
311 /* Structure for GOTD_IMSG_REF data. */
312 struct gotd_imsg_ref {
313 uint8_t id[SHA1_DIGEST_LENGTH];
315 /* Followed by name_len data bytes. */
316 } __attribute__((__packed__));
318 /* Structure for GOTD_IMSG_SYMREF data. */
319 struct gotd_imsg_symref {
322 uint8_t target_id[SHA1_DIGEST_LENGTH];
325 * Followed by name_len + target_len data bytes.
327 } __attribute__((__packed__));
329 /* Structure for GOTD_IMSG_CAPABILITIES data. */
330 struct gotd_imsg_capabilities {
331 size_t ncapabilities;
334 * Followed by ncapabilities * GOTD_IMSG_CAPABILITY.
336 } __attribute__((__packed__));
338 /* Structure for GOTD_IMSG_CAPABILITY data. */
339 struct gotd_imsg_capability {
344 * Followed by key_len + value_len data bytes.
346 } __attribute__((__packed__));
348 /* Structure for GOTD_IMSG_WANT data. */
349 struct gotd_imsg_want {
350 uint8_t object_id[SHA1_DIGEST_LENGTH];
352 } __attribute__((__packed__));
354 /* Structure for GOTD_IMSG_HAVE data. */
355 struct gotd_imsg_have {
356 uint8_t object_id[SHA1_DIGEST_LENGTH];
358 } __attribute__((__packed__));
360 /* Structure for GOTD_IMSG_ACK data. */
361 struct gotd_imsg_ack {
362 uint8_t object_id[SHA1_DIGEST_LENGTH];
364 } __attribute__((__packed__));
366 /* Structure for GOTD_IMSG_NAK data. */
367 struct gotd_imsg_nak {
368 uint8_t object_id[SHA1_DIGEST_LENGTH];
370 } __attribute__((__packed__));
372 /* Structure for GOTD_IMSG_PACKFILE_STATUS data. */
373 struct gotd_imsg_packfile_status {
376 /* Followed by reason_len data bytes. */
377 } __attribute__((__packed__));
380 /* Structure for GOTD_IMSG_REF_UPDATE data. */
381 struct gotd_imsg_ref_update {
382 uint8_t old_id[SHA1_DIGEST_LENGTH];
383 uint8_t new_id[SHA1_DIGEST_LENGTH];
389 /* Followed by name_len data bytes. */
390 } __attribute__((__packed__));
392 /* Structure for GOTD_IMSG_REF_UPDATES_START data. */
393 struct gotd_imsg_ref_updates_start {
397 /* Followed by nref_updates GOT_IMSG_REF_UPDATE_OK/NG messages. */
400 /* Structure for GOTD_IMSG_REF_UPDATE_OK data. */
401 struct gotd_imsg_ref_update_ok {
402 uint8_t old_id[SHA1_DIGEST_LENGTH];
403 uint8_t new_id[SHA1_DIGEST_LENGTH];
408 /* Followed by name_len data bytes. */
409 } __attribute__((__packed__));
411 /* Structure for GOTD_IMSG_REF_UPDATE_NG data. */
412 struct gotd_imsg_ref_update_ng {
413 uint8_t old_id[SHA1_DIGEST_LENGTH];
414 uint8_t new_id[SHA1_DIGEST_LENGTH];
419 /* Followed by name_len + reason_len data bytes. */
420 } __attribute__((__packed__));
422 /* Structure for GOTD_IMSG_SEND_PACKFILE data. */
423 struct gotd_imsg_send_packfile {
427 /* delta cache file is sent as a file descriptor */
429 /* followed by two GOTD_IMSG_PACKFILE_PIPE messages */
432 /* Structure for GOTD_IMSG_RECV_PACKFILE data. */
433 struct gotd_imsg_recv_packfile {
437 /* pack destination temp file is sent as a file descriptor */
440 /* Structure for GOTD_IMSG_PACKFILE_PIPE data. */
441 struct gotd_imsg_packfile_pipe {
445 /* Structure for GOTD_IMSG_PACKIDX_FILE data. */
446 struct gotd_imsg_packidx_file {
452 * Structure for GOTD_IMSG_PACKFILE_PROGRESS and
453 * GOTD_IMSG_PACKFILE_READY data.
455 struct gotd_imsg_packfile_progress {
467 /* Structure for GOTD_IMSG_PACKFILE_INSTALL. */
468 struct gotd_imsg_packfile_install {
470 uint8_t pack_sha1[SHA1_DIGEST_LENGTH];
473 /* Structure for GOTD_IMSG_PACKFILE_DONE data. */
474 struct gotd_imsg_packfile_done {
478 /* Structure for GOTD_IMSG_DISCONNECT data. */
479 struct gotd_imsg_disconnect {
483 /* Structure for GOTD_IMSG_CONNECT. */
484 struct gotd_imsg_connect {
490 /* Followed by username_len data bytes. */
493 /* Structure for GOTD_IMSG_CONNECT_REPO_CHILD. */
494 struct gotd_imsg_connect_repo_child {
496 enum gotd_procid proc_id;
498 /* repo child imsg pipe is passed via imsg fd */
501 /* Structure for GOTD_IMSG_AUTHENTICATE. */
502 struct gotd_imsg_auth {
509 /* Structures for GOTD_IMSG_NOTIFY. */
510 enum gotd_notification_action {
511 GOTD_NOTIF_ACTION_CREATED,
512 GOTD_NOTIF_ACTION_REMOVED,
513 GOTD_NOTIF_ACTION_CHANGED
515 /* IMSG_NOTIFY session <-> repo_write */
516 struct gotd_imsg_notification_content {
518 enum gotd_notification_action action;
519 uint8_t old_id[SHA1_DIGEST_LENGTH];
520 uint8_t new_id[SHA1_DIGEST_LENGTH];
522 /* Followed by refname_len data bytes. */
524 /* IMSG_NOTIFY session -> notify*/
525 struct gotd_imsg_notify {
526 char repo_name[NAME_MAX];
527 char subject_line[64];
530 int enter_chroot(const char *);
531 int parse_config(const char *, enum gotd_procid, struct gotd *);
532 struct gotd_repo *gotd_find_repo_by_name(const char *, struct gotd_repolist *);
533 struct gotd_repo *gotd_find_repo_by_path(const char *, struct gotd *);
534 struct gotd_uid_connection_limit *gotd_find_uid_connection_limit(
535 struct gotd_uid_connection_limit *limits, size_t nlimits, uid_t uid);
536 int gotd_parseuid(const char *s, uid_t *uid);
537 const struct got_error *gotd_parse_url(char **, char **, char **,
538 char **, const char *);
541 const struct got_error *gotd_imsg_flush(struct imsgbuf *);
542 const struct got_error *gotd_imsg_recv(struct imsg *, struct imsgbuf *, size_t);
543 const struct got_error *gotd_imsg_poll_recv(struct imsg *, struct imsgbuf *,
545 const struct got_error *gotd_imsg_recv_error(uint32_t *client_id,
547 int gotd_imsg_send_error(struct imsgbuf *ibuf, uint32_t, uint32_t,
548 const struct got_error *);
549 int gotd_imsg_send_error_event(struct gotd_imsgev *, uint32_t, uint32_t,
550 const struct got_error *);
551 void gotd_imsg_event_add(struct gotd_imsgev *);
552 int gotd_imsg_compose_event(struct gotd_imsgev *, uint16_t, uint32_t, int,
554 int gotd_imsg_forward(struct gotd_imsgev *, struct imsg *, int);
556 void gotd_imsg_send_ack(struct got_object_id *, struct imsgbuf *,
558 void gotd_imsg_send_nak(struct got_object_id *, struct imsgbuf *,