| #!/usr/bin/env python3 | |
| # SPDX-License-Identifier: MPL-2.0 | |
| # | |
| # libpathrs: safe path resolution on Linux | |
| # Copyright (C) 2019-2025 SUSE LLC | |
| # Copyright (C) 2026 Aleksa Sarai <cyphar@cyphar.com> | |
| # | |
| # This Source Code Form is subject to the terms of the Mozilla Public | |
| # License, v. 2.0. If a copy of the MPL was not distributed with this | |
| # file, You can obtain one at https://mozilla.org/MPL/2.0/. | |
| # File: examples/python/static_web.py | |
| # | |
| # An example program which provides a static webserver which will serve files | |
| # from a directory, safely resolving paths with libpathrs. | |
| import errno | |
| import os | |
| import stat | |
| import sys | |
| import flask | |
| import flask.json | |
| sys.path.append(os.path.dirname(__file__) + "/../contrib/bindings/python") | |
| import pathrs | |
| from pathrs import PathrsError | |
| app = flask.Flask(__name__) | |
| def json_dentry(dentry): | |
| st = dentry.stat(follow_symlinks=False) | |
| return { | |
| "ino": st.st_ino, | |
| "mode": stat.S_IMODE(st.st_mode), | |
| "type": { | |
| stat.S_IFREG: "regular file", | |
| stat.S_IFDIR: "directory", | |
| stat.S_IFLNK: "symlink", | |
| stat.S_IFBLK: "block device", | |
| stat.S_IFCHR: "character device", | |
| stat.S_IFIFO: "named pipe", | |
| stat.S_IFSOCK: "socket", | |
| }.get(stat.S_IFMT(st.st_mode)), | |
| } | |
| @app.route("/<path:path>") | |
| def get(path): | |
| try: | |
| handle = root.resolve(path) | |
| except PathrsError as e: | |
| e.pprint() | |
| status_code = { | |
| # No such file or directory => 404 Not Found. | |
| errno.ENOENT: 404, | |
| # Operation not permitted => 403 Forbidden. | |
| errno.EPERM: 403, | |
| # Permission denied => 403 Forbidden. | |
| errno.EACCES: 403, | |
| }.get(e.errno, 500) | |
| flask.abort(status_code, f"Could not resolve path: {e}.") | |
| with handle: | |
| try: | |
| f = handle.reopen("rb") | |
| return flask.Response( | |
| f, mimetype="application/octet-stream", direct_passthrough=True | |
| ) | |
| except IsADirectoryError: | |
| with handle.reopen_raw(os.O_RDONLY) as dirf, os.scandir(dirf.fileno()) as s: | |
| return flask.json.jsonify( | |
| {dentry.name: json_dentry(dentry) for dentry in s} | |
| ) | |
| def main(root_path=None): | |
| if root_path is None: | |
| root_path = os.getcwd() | |
| # Open a root handle. This is long-lived. | |
| global root | |
| root = pathrs.Root(root_path) | |
| # Now serve our dumb HTTP server. | |
| app.run(debug=True, port=8080) | |
| if __name__ == "__main__": | |
| main(*sys.argv[1:]) |