Atmosphere/libraries/libstratosphere/source/fssystem/fssystem_partition_file_system_meta.cpp

/*
 * Copyright (c) Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <stratosphere.hpp>

namespace ams::fssystem {

    template <typename Format>
    struct PartitionFileSystemMetaCore<Format>::PartitionFileSystemHeader {
        char signature[sizeof(Format::VersionSignature)];
        s32 entry_count;
        u32 name_table_size;
        u32 reserved;
    };
    static_assert(util::is_pod<PartitionFileSystemMeta::PartitionFileSystemHeader>::value);
    static_assert(sizeof(PartitionFileSystemMeta::PartitionFileSystemHeader) == 0x10);

    template <typename Format>
    PartitionFileSystemMetaCore<Format>::~PartitionFileSystemMetaCore() {
        this->DeallocateBuffer();
    }

    template <typename Format>
    Result PartitionFileSystemMetaCore<Format>::Initialize(fs::IStorage *storage, MemoryResource *allocator) {
        /* Validate preconditions. */
        AMS_ASSERT(allocator != nullptr);

        /* Determine the meta data size. */
        R_TRY(this->QueryMetaDataSize(std::addressof(m_meta_data_size), storage));

        /* Deallocate any old meta buffer and allocate a new one. */
        this->DeallocateBuffer();
        m_allocator = allocator;
        m_buffer = static_cast<char *>(m_allocator->Allocate(m_meta_data_size));
        R_UNLESS(m_buffer != nullptr, fs::ResultAllocationMemoryFailedInPartitionFileSystemMetaA());

        /* Perform regular initialization. */
        R_RETURN(this->Initialize(storage, m_buffer, m_meta_data_size));
    }

    template <typename Format>
    Result PartitionFileSystemMetaCore<Format>::Initialize(fs::IStorage *storage, void *meta, size_t meta_size) {
        /* Validate size for header. */
        R_UNLESS(meta_size >= sizeof(PartitionFileSystemHeader), fs::ResultInvalidSize());

        /* Read the header. */
        R_TRY(storage->Read(0, meta, sizeof(PartitionFileSystemHeader)));

        /* Set and validate the header. */
        m_header = reinterpret_cast<PartitionFileSystemHeader *>(meta);
        R_UNLESS(crypto::IsSameBytes(m_header->signature, Format::VersionSignature, sizeof(Format::VersionSignature)), typename Format::ResultSignatureVerificationFailed());

        /* Setup entries and name table. */
        const size_t entries_size = m_header->entry_count * sizeof(typename Format::PartitionEntry);
        m_entries = reinterpret_cast<PartitionEntry *>(static_cast<u8 *>(meta) + sizeof(PartitionFileSystemHeader));
        m_name_table = static_cast<char *>(meta) + sizeof(PartitionFileSystemHeader) + entries_size;

        /* Validate size for header + entries + name table. */
        R_UNLESS(meta_size >= sizeof(PartitionFileSystemHeader) + entries_size + m_header->name_table_size, fs::ResultInvalidSize());

        /* Read entries and name table. */
        R_TRY(storage->Read(sizeof(PartitionFileSystemHeader), m_entries, entries_size + m_header->name_table_size));

        /* Mark as initialized. */
        m_initialized = true;
        R_SUCCEED();
    }

    template <typename Format>
    void PartitionFileSystemMetaCore<Format>::DeallocateBuffer() {
        if (m_buffer != nullptr) {
            AMS_ABORT_UNLESS(m_allocator != nullptr);
            m_allocator->Deallocate(m_buffer, m_meta_data_size);
            m_buffer = nullptr;
        }
    }

    template <typename Format>
    const typename Format::PartitionEntry *PartitionFileSystemMetaCore<Format>::GetEntry(s32 index) const {
        if (m_initialized && 0 <= index && index < static_cast<s32>(m_header->entry_count)) {
            return std::addressof(m_entries[index]);
        }
        return nullptr;
    }

    template <typename Format>
    s32 PartitionFileSystemMetaCore<Format>::GetEntryCount() const {
        if (m_initialized) {
            return m_header->entry_count;
        }
        return 0;
    }

    template <typename Format>
    s32 PartitionFileSystemMetaCore<Format>::GetEntryIndex(const char *name) const {
        /* Fail if not initialized. */
        if (!m_initialized) {
            return 0;
        }

        for (s32 i = 0; i < static_cast<s32>(m_header->entry_count); i++) {
            const auto &entry = m_entries[i];

            /* Name offset is invalid. */
            if (entry.name_offset >= m_header->name_table_size) {
                return 0;
            }

            /* Compare to input name. */
            const s32 max_name_len = m_header->name_table_size - entry.name_offset;
            if (std::strncmp(std::addressof(m_name_table[entry.name_offset]), name, max_name_len) == 0) {
                return i;
            }
        }

        /* Not found. */
        return -1;
    }

    template <typename Format>
    const char *PartitionFileSystemMetaCore<Format>::GetEntryName(s32 index) const {
        if (m_initialized && index < static_cast<s32>(m_header->entry_count)) {
            return std::addressof(m_name_table[this->GetEntry(index)->name_offset]);
        }
        return nullptr;
    }

    template <typename Format>
    size_t PartitionFileSystemMetaCore<Format>::GetHeaderSize() const {
        return sizeof(PartitionFileSystemHeader);
    }

    template <typename Format>
    size_t PartitionFileSystemMetaCore<Format>::GetMetaDataSize() const {
        return m_meta_data_size;
    }

    template <typename Format>
    Result PartitionFileSystemMetaCore<Format>::QueryMetaDataSize(size_t *out_size, fs::IStorage *storage) {
        /* Read and validate the header. */
        PartitionFileSystemHeader header;
        R_TRY(storage->Read(0, std::addressof(header), sizeof(PartitionFileSystemHeader)));
        R_UNLESS(crypto::IsSameBytes(std::addressof(header), Format::VersionSignature, sizeof(Format::VersionSignature)), typename Format::ResultSignatureVerificationFailed());

        /* Output size. */
        *out_size = sizeof(PartitionFileSystemHeader) + header.entry_count * sizeof(typename Format::PartitionEntry) + header.name_table_size;
        R_SUCCEED();
    }

    template class PartitionFileSystemMetaCore<impl::PartitionFileSystemFormat>;
    template class PartitionFileSystemMetaCore<impl::Sha256PartitionFileSystemFormat>;

    Result Sha256PartitionFileSystemMeta::Initialize(fs::IStorage *base_storage, MemoryResource *allocator, const void *hash, size_t hash_size, util::optional<u8> suffix) {
        /* Ensure preconditions. */
        R_UNLESS(hash_size == crypto::Sha256Generator::HashSize, fs::ResultPreconditionViolation());

        /* Get metadata size. */
        R_TRY(QueryMetaDataSize(std::addressof(m_meta_data_size), base_storage));

        /* Ensure we have no buffer. */
        this->DeallocateBuffer();

        /* Set allocator and allocate buffer. */
        m_allocator = allocator;
        m_buffer = static_cast<char *>(m_allocator->Allocate(m_meta_data_size));
        R_UNLESS(m_buffer != nullptr, fs::ResultAllocationMemoryFailedInPartitionFileSystemMetaB());

        /* Read metadata. */
        R_TRY(base_storage->Read(0, m_buffer, m_meta_data_size));

        /* Calculate hash. */
        char calc_hash[crypto::Sha256Generator::HashSize];
        {
            crypto::Sha256Generator generator;
            generator.Initialize();
            generator.Update(m_buffer, m_meta_data_size);
            if (suffix) {
                u8 suffix_val = *suffix;
                generator.Update(std::addressof(suffix_val), 1);
            }
            generator.GetHash(calc_hash, sizeof(calc_hash));
        }

        /* Ensure hash is valid. */
        R_UNLESS(crypto::IsSameBytes(hash, calc_hash, sizeof(calc_hash)), fs::ResultSha256PartitionHashVerificationFailed());

        /* Give access to Format */
        using Format = impl::Sha256PartitionFileSystemFormat;

        /* Set header. */
        m_header = reinterpret_cast<PartitionFileSystemHeader *>(m_buffer);
        R_UNLESS(crypto::IsSameBytes(m_header->signature, Format::VersionSignature, sizeof(Format::VersionSignature)), typename Format::ResultSignatureVerificationFailed());

        /* Validate size for entries and name table. */
        const size_t entries_size = m_header->entry_count * sizeof(typename Format::PartitionEntry);
        R_UNLESS(m_meta_data_size >= sizeof(PartitionFileSystemHeader) + entries_size + m_header->name_table_size, fs::ResultInvalidSha256PartitionMetaDataSize());

        /* Set entries and name table. */
        m_entries = reinterpret_cast<PartitionEntry *>(m_buffer + sizeof(PartitionFileSystemHeader));
        m_name_table = m_buffer + sizeof(PartitionFileSystemHeader) + entries_size;

        /* We initialized. */
        m_initialized = true;
        R_SUCCEED();
    }

}