FilePathUtils.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/FilePathUtils.hpp
// \brief Utilities for resolving and validating file paths
// ======================================================================
#ifndef Os_FilePathUtils_hpp_
#define Os_FilePathUtils_hpp_

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/StringBase.hpp>
#include <config/FppConstantsAc.hpp>

namespace Os {

namespace FilePathUtils {

enum Status {
    VALID,            
    OUTSIDE_SANDBOX,  
    INVALID_PATH,     
    TOO_LONG,         
};

static constexpr FwSizeType MAX_PATH_LENGTH = FileNameStringSize;

Status resolvePath(const char* path, const char* baseDir, char* resolvedOut, FwSizeType resolvedSize);

Status resolvePath(const Fw::ConstStringBase& path, const Fw::ConstStringBase& baseDir, Fw::StringBase& resolvedOut);

Status resolveFromCwd(const char* path, char* resolvedOut, FwSizeType resolvedSize);

Status checkContainment(const char* resolvedPath, const char* allowedDirectory);

}  // namespace FilePathUtils
}  // namespace Os

#endif