xref: /aosp_15_r20/system/vold/KeyBuffer.h (revision f40fafd4c6c2594924d919feffc1a1fd6e3b30f3)

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * 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 ANDROID_VOLD_KEYBUFFER_H
#define ANDROID_VOLD_KEYBUFFER_H

#include <string.h>
#include <memory>
#include <type_traits>
#include <vector>

namespace android {
namespace vold {

// Allocator that delegates useful work to standard one but zeroes data before deallocating.
class ZeroingAllocator : public std::allocator<char> {
  public:
    void deallocate(value_type* p, size_type n) {
        memset_explicit(p, 0, n);
        std::allocator<char>::deallocate(p, n);
    }

    template <class Other>
    struct rebind {
        static_assert(std::is_same_v<char, Other>, "ZeroingAllocator is only defined for char");
        using other = ZeroingAllocator;
    };
};

// Char vector that zeroes memory when deallocating.
using KeyBuffer = std::vector<char, ZeroingAllocator>;

// Convenience methods to concatenate key buffers.
KeyBuffer operator+(KeyBuffer&& lhs, const KeyBuffer& rhs);
KeyBuffer operator+(KeyBuffer&& lhs, const char* rhs);

}  // namespace vold
}  // namespace android

#endif