safepath: new project.

1 files changed, 59 insertions, 0 deletions

diff --git a/safepath.h b/safepath.h
new file mode 100644
index 0000000..b6a8a39
--- /dev/null
+++ b/safepath.h
@@ -0,0 +1,59 @@
+/*
+ * safepath: safe path traversal for POSIX systems
+ * Copyright 2022 Kaz Kylheku <kaz@kylheku.com>
+ *
+ * BSD-2 License
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef SAFEPATH_3DFC_9950_H
+#define SAFEPATH_3DFC_9950_H
+
+#include <sys/types.h>
+#include <stdio.h>
+
+/*
+ * safepatch_check error codes
+ */
+enum {
+  SAFEPATH_OK,                  /* path appears safe */
+  SAFEPATH_UNSAFE,              /* path traversible, unsafe */
+  SAFEPATH_PERM,                /* path not traversible due to perms */
+  SAFEPATH_NOENT,               /* component other than last doesn't exist */
+  SAFEPATH_INVAL,               /* path is invalid */
+  SAFEPATH_NOMEM,               /* out of memory */
+  SAFEPATH_LOOP,                /* more than 8 levels of symlink */
+};
+
+int safepath_check(const char *name);
+
+/* Common POSIX API wrappers */
+int safepath_open(const char *name, int flags);
+int safepath_open_mode(const char *name, int flags, mode_t mode);
+
+/* STDIO wrappers */
+FILE* safepath_fopen(const char *name, const char *mode);
+FILE* safepath_freopen(const char *name, const char *mode, FILE *);
+
+#endif