FILE_ACCESS_MASK.hh

Go to the documentation of this file.

/*
 * Copyright 2021 Assured Information Security, Inc.
 *
 * 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.
 */
#pragma once
 
#include "ACCESS_MASK.hh"
 
namespace introvirt {
namespace windows {
namespace nt {
 
enum FileAccessMaskFlag {
    FILE_READ_DATA = 0x001,
 
    FILE_WRITE_DATA = 0x002,
 
    FILE_APPEND_DATA = 0x004,
 
    FILE_EXECUTE = 0x020,
 
    FILE_READ_EA = 0x008,
 
    FILE_WRITE_EA = 0x010,
 
    FILE_READ_ATTRIBUTES = 0x080,
 
    FILE_WRITE_ATTRIBUTES = 0x100,
 
    FILE_LIST_DIRECTORY = 0x001,
 
    FILE_ADD_FILE = 0x002,
 
    FILE_ADD_SUBDIRECTORY = 0x004,
 
    FILE_TRAVERSE = 0x020,
 
    FILE_DELETE_CHILD = 0x040,
 
    FILE_CREATE_PIPE_INSTANCE = 0x004,
 
    FILE_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x1FF,
 
    FILE_GENERIC_EXECUTE = FILE_EXECUTE | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE,
 
    FILE_GENERIC_READ =
        FILE_READ_ATTRIBUTES | FILE_READ_DATA | FILE_READ_EA | READ_CONTROL | SYNCHRONIZE,
 
    // Generic write bits for a file
    FILE_GENERIC_WRITE = FILE_APPEND_DATA | FILE_WRITE_ATTRIBUTES | FILE_WRITE_DATA |
                         FILE_WRITE_EA | READ_CONTROL | SYNCHRONIZE,
};
 
class FILE_ACCESS_MASK final : public ACCESS_MASK {
  public:
    bool has(FileAccessMaskFlag flag) const { return (value() & flag) == flag; }
 
    void set(FileAccessMaskFlag flag) { value(value() | flag); }
 
    void clear(FileAccessMaskFlag flag) { value(value() & ~flag); }
 
    AccessMaskType type() const override { return FileAccessMask; }
 
    // Constructors and assignment operators
    FILE_ACCESS_MASK() = default;
    FILE_ACCESS_MASK(uint32_t mask) : ACCESS_MASK(mask) {}
 
    FILE_ACCESS_MASK(const FILE_ACCESS_MASK&) = default;
    FILE_ACCESS_MASK& operator=(const FILE_ACCESS_MASK&) = default;
};
 
const std::string& to_string(FileAccessMaskFlag);
std::ostream& operator<<(std::ostream&, FileAccessMaskFlag);
 
std::string to_string(FILE_ACCESS_MASK);
std::ostream& operator<<(std::ostream&, FILE_ACCESS_MASK);
 
} /* namespace nt */
} /* namespace windows */
} /* namespace introvirt */