blob: dea0d181333a399536c3bddd94c604bbf7b72628 [file] [log] [blame]
// Copyright 2018 The Crashpad Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CRASHPAD_SNAPSHOT_SANITIZED_MEMORY_SNAPSHOT_SANITIZED_H_
#define CRASHPAD_SNAPSHOT_SANITIZED_MEMORY_SNAPSHOT_SANITIZED_H_
#include <stdint.h>
#include "snapshot/memory_snapshot.h"
#include "util/misc/range_set.h"
namespace crashpad {
namespace internal {
//! \brief A MemorySnapshot which wraps and filters sensitive information from
//! another MemorySnapshot.
//!
//! This class redacts all data from the wrapped MemorySnapshot unless:
//! 1. The data is pointer aligned and points into an allowed address range.
//! 2. The data is pointer aligned and is a small integer.
class MemorySnapshotSanitized final : public MemorySnapshot {
public:
//! \brief Redacted data is replaced with this value, casted to the
//! appropriate size for a pointer in the target process.
static constexpr uint64_t kDefaced = 0x0defaced0defaced;
//! \brief Pointer-aligned data smaller than this value is not redacted.
static constexpr uint64_t kSmallWordMax = 4096;
//! \brief Constructs this object.
//!
//! \param[in] snapshot The MemorySnapshot to sanitize.
//! \param[in] ranges A set of allowed address ranges.
//! \param[in] is_64_bit `true` if this memory is for a 64-bit process.
MemorySnapshotSanitized(const MemorySnapshot* snapshot,
RangeSet* ranges,
bool is_64_bit);
MemorySnapshotSanitized(const MemorySnapshotSanitized&) = delete;
MemorySnapshotSanitized& operator=(const MemorySnapshotSanitized&) = delete;
~MemorySnapshotSanitized() override;
// MemorySnapshot:
uint64_t Address() const override;
size_t Size() const override;
bool Read(Delegate* delegate) const override;
const MemorySnapshot* MergeWithOtherSnapshot(
const MemorySnapshot* other) const override {
return nullptr;
}
private:
const MemorySnapshot* snapshot_;
RangeSet* ranges_;
bool is_64_bit_;
};
} // namespace internal
} // namespace crashpad
#endif // CRASHPAD_SNAPSHOT_SANITIZED_MEMORY_SNAPSHOT_SANITIZED_H_