Compare commits

...

8 commits
1.07 ... master

Author SHA1 Message Date
Mike Barnes 5a9b2518be Allow dropping privs on platforms without setresuid() 2022-01-29 16:14:37 +11:00
Mike Barnes 47e075383f Set facility with openlog, fix message priorites. 2022-01-29 16:01:29 +11:00
Solene Rapenne 01f2503376 fix NetBSD macro check 2022-01-26 13:04:04 +01:00
Solene Rapenne ed6dc1ed12 add .gitignore for build artifacts 2021-12-13 21:44:03 +01:00
Solene Rapenne 0d3d453498 test.sh should be executable out of the box 2021-12-13 21:34:49 +01:00
Solene Rapenne 914a143c3f add Nix shell file 2021-12-13 21:34:35 +01:00
Solene Rapenne a319de23f7 Add configure script 2021-12-13 21:32:08 +01:00
prx 15d09d2c01 fix user chroot issue + style 2021-10-21 11:41:22 +02:00
6 changed files with 191 additions and 164 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
*.o
vger

14
configure vendored Executable file
View file

@ -0,0 +1,14 @@
#!/bin/sh
OS="$(uname -s)"
case "$OS" in
Linux)
EXTRAFLAGS=-lbsd
;;
*)
EXTRAFLAGS=""
;;
esac
echo "EXTRAFLAGS=${EXTRAFLAGS}" > config.mk

327
main.c
View file

@ -20,25 +20,25 @@
#include "opts.h"
#include "utils.h"
/* lenght of "gemini://" */
/* length of "gemini://" */
#define GEMINI_PART 9
/*
* number of bytes to read with fgets() : 2014 + 1
* fgets() reads at most size-1 (1024 here)
* see https://gemini.circumlunar.space/docs/specification.html.
/*
* number of bytes to read with fgets() : 2014 + 1.
* fgets() reads at most size-1 (1024 here).
* See https://gemini.circumlunar.space/docs/specification.html.
*/
#define GEMINI_REQUEST_MAX 1025
void autoindex(const char *);
void cgi(const char *cgicmd);
void autoindex(const char *);
void cgi (const char *cgicmd);
void display_file(const char *);
void drop_privileges(const char *, const char *);
void echdir(const char *);
void status(const int, const char *);
void status_redirect(const int, const char *);
void status_error(const int, const char*);
int uridecode(char *);
void echdir (const char *);
void status (const int, const char *);
void status_redirect(const int, const char *);
void status_error(const int, const char *);
int uridecode (char *);
void
@ -46,7 +46,7 @@ echdir(const char *path)
{
if (chdir(path) == -1) {
switch (errno) {
case ENOTDIR: /* FALLTHROUGH */
case ENOTDIR: /* FALLTHROUGH */
case ENOENT:
status_error(51, "file not found");
break;
@ -64,36 +64,34 @@ echdir(const char *path)
int
uridecode(char *uri)
{
int n = 0;
char c = '\0';
long l = 0;
char *pos = NULL;
int n = 0;
char c = '\0';
long l = 0;
char *pos = NULL;
if ((pos = strchr(uri, '%')) == NULL) {
return n;
}
while ((pos = strchr(pos, '%')) != NULL) {
if (strlen(pos) < 3) {
return n;
}
if ((pos = strchr(uri, '%')) == NULL)
return n;
char hex[3] = {'\0'};
for (size_t i=0; i < 2; i++) {
hex[i] = tolower(pos[i+1]);
}
errno = 0;
l = strtol(hex, 0, 16);
if (errno == ERANGE && (l == LONG_MAX || l == LONG_MIN)) {
/* conversion failed */
continue;
}
c = (char)l;
pos[0] = c;
/* rewind of two char to remove %hex */
memmove(pos+1 , pos + 3, strlen(pos+3) + 1); /* +1 for \0*/
n++;
pos++; /* avoid infinite loop */
}
while ((pos = strchr(pos, '%')) != NULL) {
if (strlen(pos) < 3)
return n;
char hex[3] = {'\0'};
for (size_t i = 0; i < 2; i++)
hex[i] = tolower(pos[i + 1]);
errno = 0;
l = strtol(hex, 0, 16);
if (errno == ERANGE && (l == LONG_MAX || l == LONG_MIN))
continue; /* conversion failed */
c = (char)l;
pos[0] = c;
/* rewind of two char to remove %hex */
memmove(pos + 1, pos + 3, strlen(pos + 3) + 1); /* +1 for \0 */
n++;
pos++; /* avoid infinite loop */
}
return n;
}
@ -109,60 +107,68 @@ drop_privileges(const char *user, const char *path)
if (strlen(user) > 0) {
/* is root? */
if (getuid() != 0) {
errlog("chroot requires program to be run as root");
}
if (getuid() != 0)
errlog("chroot requires program to be run as root");
/* search user uid from name */
if ((pw = getpwnam(user)) == NULL) {
errlog("the user %s can't be found on the system", user);
}
if ((pw = getpwnam(user)) == NULL)
errlog("the user %s can't be found on the system", user);
/* chroot worked? */
if (chroot(path) != 0) {
errlog("the chroot_dir %s can't be used for chroot", path);
}
if (chroot(path) != 0)
errlog("the chroot_dir %s can't be used for chroot", path);
chrooted = 1;
echdir("/");
/* drop privileges */
#if defined (__OpenBSD__) || defined(__FreeBSD__)
if (setgroups(1, &pw->pw_gid) ||
setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) ||
setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid)) {
errlog("dropping privileges to user %s (uid=%i) failed",
user, pw->pw_uid);
}
#else
if (setgroups(1, &pw->pw_gid) ||
setgid(pw->pw_gid) ||
setuid(pw->pw_uid)) {
errlog("dropping privileges to user %s (uid=%i) failed",
user, pw->pw_uid);
}
#endif
}
#ifdef __OpenBSD__
/*
* prevent access to files other than the one in path
*/
if (chrooted) {
eunveil("/", "r");
} else {
eunveil(path, "r");
}
if (chrooted)
eunveil("/", "r");
else
eunveil(path, "r");
/* permission to execute what's inside cgidir */
if (strlen(cgidir) > 0) {
eunveil(cgidir, "rx");
}
eunveil(NULL,NULL); /* no more call to unveil() */
if (strlen(cgidir) > 0)
eunveil(cgidir, "rx");
eunveil(NULL, NULL); /* no more call to unveil() */
/* promise permissions */
if (strlen(cgidir) > 0) {
epledge("stdio rpath exec", NULL);
} else {
epledge("stdio rpath", NULL);
}
if (strlen(cgidir) > 0)
epledge("stdio rpath exec", NULL);
else
epledge("stdio rpath", NULL);
#endif
if (!chrooted)
echdir(path); /* move to the gemini data directory */
}
void
status(const int code, const char *file_mime)
{
if (strcmp(file_mime, "text/gemini") == 0) {
printf("%i %s; %s\r\n", code, file_mime, lang);
} else {
printf("%i %s\r\n", code, file_mime);
}
if (strcmp(file_mime, "text/gemini") == 0)
printf("%i %s; %s\r\n", code, file_mime, lang);
else
printf("%i %s\r\n", code, file_mime);
}
void
@ -176,21 +182,25 @@ void
status_error(const int code, const char *reason)
{
printf("%i %s\r\n",
code, reason);
code, reason);
}
void
display_file(const char *fname)
{
FILE *fd = NULL;
struct stat sb = {0};
ssize_t nread = 0;
const char *file_mime;
char *buffer[BUFSIZ];
char target[FILENAME_MAX] = {'\0'};
char tmp[PATH_MAX] = {'\0'}; /* used to build temporary path */
FILE *fd = NULL;
struct stat sb = {0};
ssize_t nread = 0;
const char *file_mime;
char *buffer[BUFSIZ];
char target[FILENAME_MAX] = {'\0'};
char tmp[PATH_MAX] = {'\0'}; /* used to build
* temporary path */
/* special case : fname empty. The user requested just the directory name */
/*
* special case : fname empty. The user requested just the directory
* name
*/
if (strlen(fname) == 0) {
if (stat("index.gmi", &sb) == 0) {
/* there is index.gmi in the current directory */
@ -204,17 +214,17 @@ display_file(const char *fname)
goto err;
}
}
/* this is to check if path exists and obtain metadata later */
if (stat(fname, &sb) == -1) {
/* check if fname is a symbolic link
* if so, redirect using its target */
/*
* check if fname is a symbolic link if so, redirect using
* its target
*/
if (lstat(fname, &sb) != -1 && S_ISLNK(sb.st_mode) == 1)
goto redirect;
goto redirect;
else
goto err;
goto err;
}
/* check if directory */
if (S_ISDIR(sb.st_mode) != 0) {
/* no ending "/", redirect to "fname/" */
@ -223,9 +233,9 @@ display_file(const char *fname)
status_redirect(31, tmp);
return;
}
/* open the file requested */
if ((fd = fopen(fname, "r")) == NULL) { goto err; }
if ((fd = fopen(fname, "r")) == NULL)
goto err;
file_mime = get_file_mime(fname, default_mime);
@ -234,30 +244,28 @@ display_file(const char *fname)
/* read the file byte after byte in buffer and write it to stdout */
while ((nread = fread(buffer, 1, sizeof(buffer), fd)) != 0)
fwrite(buffer, 1, nread, stdout);
goto closefd; /* close file descriptor */
syslog(LOG_DAEMON, "path served %s", fname);
goto closefd; /* close file descriptor */
syslog(LOG_INFO, "path served %s", fname);
return;
err:
/* return an error code and no content */
status_error(51, "file not found");
syslog(LOG_DAEMON, "path invalid %s", fname);
syslog(LOG_INFO, "path invalid %s", fname);
goto closefd;
redirect:
/* read symbolic link target to redirect */
if (readlink(fname, target, FILENAME_MAX) == -1) {
goto err;
}
if (readlink(fname, target, FILENAME_MAX) == -1)
goto err;
status_redirect(30, target);
syslog(LOG_DAEMON, "redirection from %s to %s", fname, target);
syslog(LOG_INFO, "redirection from %s to %s", fname, target);
closefd:
if (S_ISREG(sb.st_mode) != 0) {
fclose(fd);
}
if (S_ISREG(sb.st_mode) != 0)
fclose(fd);
}
void
@ -265,10 +273,10 @@ autoindex(const char *path)
{
/* display liks to files in path + a link to parent (..) */
int n = 0;
struct dirent **namelist; /* this must be freed at last */
int n = 0;
struct dirent **namelist; /* this must be freed at last */
syslog(LOG_DAEMON, "autoindex: %s", path);
syslog(LOG_INFO, "autoindex: %s", path);
/* use alphasort to always have the same order on every system */
if ((n = scandir(path, &namelist, NULL, alphasort)) < 0) {
@ -276,19 +284,18 @@ autoindex(const char *path)
errlog("Can't scan %s", path);
} else {
status(20, "text/gemini");
printf("=> .. ../\n"); /* display link to parent */
for(int j = 0; j < n; j++) {
printf("=> .. ../\n"); /* display link to parent */
for (int j = 0; j < n; j++) {
/* skip self and parent */
if ((strcmp(namelist[j]->d_name, ".") == 0) ||
(strcmp(namelist[j]->d_name, "..") == 0)) {
continue;
}
/* add "/" at the end of a directory path */
if (namelist[j]->d_type == DT_DIR) {
printf("=> ./%s/ %s/\n", namelist[j]->d_name, namelist[j]->d_name);
} else {
printf("=> ./%s %s\n", namelist[j]->d_name, namelist[j]->d_name);
}
if (namelist[j]->d_type == DT_DIR)
printf("=> ./%s/ %s/\n", namelist[j]->d_name, namelist[j]->d_name);
else
printf("=> ./%s %s\n", namelist[j]->d_name, namelist[j]->d_name);
free(namelist[j]);
}
free(namelist);
@ -309,20 +316,20 @@ cgi(const char *cgicmd)
int
main(int argc, char **argv)
{
char request [GEMINI_REQUEST_MAX] = {'\0'};
char user [_SC_LOGIN_NAME_MAX] = "";
char hostname [GEMINI_REQUEST_MAX] = {'\0'};
char query [PATH_MAX] = {'\0'};
char chroot_dir[PATH_MAX] = DEFAULT_CHROOT;
char file [FILENAME_MAX] = DEFAULT_INDEX;
char dir [PATH_MAX] = {'\0'};
char *pos = NULL;
int option = 0;
int virtualhost = 0;
int docgi = 0;
char request [GEMINI_REQUEST_MAX] = {'\0'};
char user [_SC_LOGIN_NAME_MAX] = "";
char hostname [GEMINI_REQUEST_MAX] = {'\0'};
char query [PATH_MAX] = {'\0'};
char chroot_dir[PATH_MAX] = DEFAULT_CHROOT;
char file [FILENAME_MAX] = DEFAULT_INDEX;
char dir [PATH_MAX] = {'\0'};
char *pos = NULL;
int option = 0;
int virtualhost = 0;
int docgi = 0;
/*
* request : contain the whole request from client : gemini://...\r\n
* request : contain the whole request from client : gemini://...\r\n
* user : username, used in drop_privileges()
* hostname : extracted from hostname. used with virtualhosts and cgi SERVER_NAME
* query : file requested in cgi : gemini://...?query
@ -358,6 +365,10 @@ main(int argc, char **argv)
break;
}
}
/*
* set logging options and defaults
*/
openlog("vger", LOG_PID, LOG_DAEMON);
/*
* do chroot if an user is supplied
@ -375,19 +386,17 @@ main(int argc, char **argv)
status(59, "request is too short and probably empty");
errlog("request is too short and probably empty");
/* error before reading anything */
/* error before reading anything */
} else if (ferror(stdin)) {
status(59, "Error while reading request");
errlog("Error while reading request: %s", request);
}
}
/* check if string ends with '\n', or to long */
if (request[strnlen(request, GEMINI_REQUEST_MAX) - 1] != '\n') {
status(59, "request is too long (1024 max)");
errlog("request is too long (1024 max): %s", request);
}
/* remove \r\n at the end of string */
pos = strchr(request, '\r');
if (pos != NULL)
@ -402,98 +411,94 @@ main(int argc, char **argv)
errlog("request «%s» doesn't match gemini://",
request);
}
syslog(LOG_DAEMON, "request %s", request);
syslog(LOG_INFO, "request %s", request);
/* remove the gemini:// part */
memmove(request, request + GEMINI_PART, strlen(request) +1 - GEMINI_PART);
memmove(request, request + GEMINI_PART, strlen(request) + 1 - GEMINI_PART);
/* remove all "/.." for safety reasons */
while ((pos = strstr(request, "/..")) != NULL ) {
memmove(request, pos+3, strlen(pos) +1 - 3); /* "/.." = 3 */
}
echdir(chroot_dir); /* move to chroot */
while ((pos = strstr(request, "/..")) != NULL)
memmove(request, pos + 3, strlen(pos) + 1 - 3); /* "/.." = 3 */
/* look for hostname in request : first thing before first / if any */
pos = strchr(request, '/');
if (pos != NULL) {
/* copy what's after hostname in dir */
estrlcpy(dir, pos, strlen(pos)+1);
estrlcpy(dir, pos, strlen(pos) + 1);
/* just keep hostname in request : stop the string with \0 */
pos[0] = '\0';
}
/* check if client added :port at end of hostname and remove it */
pos = strchr(request, ':');
if (pos != NULL) {
/* end string at :*/
/* end string at : */
pos[0] = '\0';
}
/* copy hostname from request */
estrlcpy(hostname, request, sizeof(hostname));
/* remove leading '/' in dir */
while (dir[0] == '/') {
memmove(dir, dir+1, strlen(dir+1)+1);
}
while (dir[0] == '/')
memmove(dir, dir + 1, strlen(dir + 1) + 1);
if (virtualhost) {
/* add hostname at the beginning of the dir path */
char tmp[PATH_MAX] = {'\0'};
char tmp [PATH_MAX] = {'\0'};
estrlcpy(tmp, hostname, sizeof(tmp));
estrlcat(tmp, "/", sizeof(tmp));
estrlcat(tmp, dir, sizeof(tmp));
estrlcpy(dir, tmp, sizeof(dir));
}
/* percent decode */
uridecode(dir);
/*
* split dir and filename.
* file is last part after last '/'.
* if none found, then requested file is actually a directory
/*
* split dir and filename. file is last part after last '/'. if none
* found, then requested file is actually a directory
*/
if (strlen(dir) > 0) {
pos = strrchr(dir, '/');
if (pos != NULL) {
estrlcpy(file, pos+1, sizeof(file)); /* +1 : no leading '/' */
estrlcpy(file, pos + 1, sizeof(file)); /* +1 : no leading '/' */
pos[0] = '\0';
if (strlen(dir) > 0) {
echdir(dir); /* change directory to requested directory */
}
/* change directory to requested directory */
if (strlen(dir) > 0)
echdir(dir);
} else {
estrlcpy(file, dir, sizeof(file));
}
}
if (docgi) {
/* check if directory is cgidir */
char cgifp[PATH_MAX] = {'\0'};
char cgifp [PATH_MAX] = {'\0'};
estrlcpy(cgifp, chroot_dir, sizeof(cgifp));
if (cgifp[strlen(cgifp)-1] != '/') {
estrlcat(cgifp, "/", sizeof(cgifp));
}
if (cgifp[strlen(cgifp) - 1] != '/')
estrlcat(cgifp, "/", sizeof(cgifp));
estrlcat(cgifp, dir, sizeof(cgifp));
if (strcmp(cgifp, cgidir) != 0) {
/* not cgipath, display file content */
/* not cgipath, display file content */
if (strcmp(cgifp, cgidir) != 0)
goto file_to_stdout;
}
/* set env variables for CGI */
/* see https://lists.orbitalfox.eu/archives/gemini/2020/000315.html */
/*
* see
* https://lists.orbitalfox.eu/archives/gemini/2020/000315.htm
* l
*/
esetenv("GATEWAY_INTERFACE", "CGI/1.1", 1);
esetenv("SERVER_PROTOCOL", "GEMINI", 1);
esetenv("SERVER_SOFTWARE", "vger/1", 1);
/* look for "?" if any to set query for cgi, remove it*/
/* look for "?" if any to set query for cgi, remove it */
pos = strchr(file, '?');
if (pos != NULL) {
estrlcpy(query, pos+1, sizeof(query));
estrlcpy(query, pos + 1, sizeof(query));
esetenv("QUERY_STRING", query, 1);
pos[0] = '\0';
}
/* look for an extension to find PATH_INFO */
pos = strrchr(file, '.');
if (pos != NULL) {
@ -501,7 +506,7 @@ main(int argc, char **argv)
pos = strchr(pos, '/');
if (pos != NULL) {
setenv("PATH_INFO", pos, 1);
pos[0] = '\0'; /* keep only script name */
pos[0] = '\0'; /* keep only script name */
}
}
esetenv("SCRIPT_NAME", file, 1);
@ -510,10 +515,12 @@ main(int argc, char **argv)
cgi(file);
return 0;
}
file_to_stdout:
/* regular file to stdout */
display_file(file);
/* end logging */
closelog();
return (0);
}

4
shell.nix Normal file
View file

@ -0,0 +1,4 @@
with (import <nixpkgs> {});
mkShell {
buildInputs = [ gcc libbsd gnumake ];
}

0
tests/test.sh Normal file → Executable file
View file

View file

@ -8,7 +8,7 @@
#include "utils.h"
#if defined(__OpenBSD__) || defined(__FreeBSD__) || defined( _NetBSD__) || defined(__DragonFly__)
#if defined(__OpenBSD__) || defined(__FreeBSD__) || defined( __NetBSD__) || defined(__DragonFly__)
#include <string.h>
#else
#include <bsd/string.h>
@ -25,7 +25,7 @@ void
eunveil(const char *path, const char *permissions)
{
if (unveil(path, permissions) == -1) {
syslog(LOG_DAEMON, "unveil on %s failed", path);
syslog(LOG_ERR, "unveil on %s failed", path);
err(1, "unveil on %s failed", path);
}
}
@ -34,7 +34,7 @@ void
epledge(const char *promises, const char *execpromises)
{
if (pledge(promises, execpromises) == -1) {
syslog(LOG_DAEMON, "pledge failed for: %s", promises);
syslog(LOG_ERR, "pledge failed for: %s", promises);
err(1, "pledge failed for: %s", promises);
}
}
@ -89,6 +89,6 @@ errlog(const char *format, ...)
vsnprintf(e, sizeof(e), format, ap);
va_end(ap);
syslog(LOG_DAEMON, "%s", e);
syslog(LOG_ERR, "%s", e);
err(1, "%s", e);
}