donner::svg::SandboxedFileResourceLoader Class Reference

A resource loader that loads files from a sandboxed directory. More...

#include "donner/svg/resources/SandboxedFileResourceLoader.h"

Inheritance diagram for donner::svg::SandboxedFileResourceLoader:

Public Member Functions
	SandboxedFileResourceLoader (const std::filesystem::path &root, const std::filesystem::path &documentPath, size_t maximumResourceSize=kDefaultMaximumResourceSize)
	Create a new resource loader that loads files sandboxed within the given root directory.
	SandboxedFileResourceLoader (const SandboxedFileResourceLoader &)=delete
SandboxedFileResourceLoader &	operator= (const SandboxedFileResourceLoader &)=delete
	SandboxedFileResourceLoader (SandboxedFileResourceLoader &&)=delete
SandboxedFileResourceLoader &	operator= (SandboxedFileResourceLoader &&)=delete
	~SandboxedFileResourceLoader () override
	Destructor.
std::variant< std::vector< uint8_t >, ResourceLoaderError >	fetchExternalResource (std::string_view url) override
	Fetch external resource from a given URL.
Public Member Functions inherited from donner::svg::ResourceLoaderInterface
	ResourceLoaderInterface ()=default
	Default constructor.
	ResourceLoaderInterface (const ResourceLoaderInterface &)=delete
ResourceLoaderInterface &	operator= (const ResourceLoaderInterface &)=delete
	ResourceLoaderInterface (ResourceLoaderInterface &&)=delete
ResourceLoaderInterface &	operator= (ResourceLoaderInterface &&)=delete
virtual	~ResourceLoaderInterface ()=default
	Destructor.

Static Public Attributes
static constexpr size_t	kDefaultMaximumResourceSize = 16 * 1024 * 1024
	Default maximum size of one external resource.
static constexpr size_t	kMaximumPathBytes = 4096
	Maximum byte length accepted for an untrusted filesystem URL.
static constexpr size_t	kMaximumPathComponents = 256
	Maximum number of components accepted for an untrusted filesystem URL.

Detailed Description

A resource loader that loads files from a sandboxed directory.

Constructor & Destructor Documentation

SandboxedFileResourceLoader()

donner::svg::SandboxedFileResourceLoader::SandboxedFileResourceLoader ( const std::filesystem::path & root, const std::filesystem::path & documentPath, size_t maximumResourceSize = kDefaultMaximumResourceSize )

explicit

Create a new resource loader that loads files sandboxed within the given root directory.

Relative resource paths resolve from the documentPath directory, which may lie outside root. The document path is trusted configuration; every fetched resource must remain within root, including after resolving ".." components.

Parameters

root	Sandbox directory, loads outside of this directory will be rejected.
documentPath	Path to the document being loaded, used to resolve relative paths.
maximumResourceSize	Maximum number of bytes read from one resource.

Member Function Documentation

fetchExternalResource()

std::variant< std::vector< uint8_t >, ResourceLoaderError > donner::svg::SandboxedFileResourceLoader::fetchExternalResource ( std::string_view url )

overridevirtual

Fetch external resource from a given URL.

Parameters

url	URL of the external resource.

Returns

A vector containing the fetched data.

Implements donner::svg::ResourceLoaderInterface.

---

The documentation for this class was generated from the following file:

• donner/svg/resources/SandboxedFileResourceLoader.h