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 <introvirt/util/json/json.hh>
 
#include <cstdint>
#include <ostream>
#include <string>
 
namespace introvirt {
namespace windows {
namespace nt {
 
enum AccessMaskFlag {
    DELETE = 0x010000,
 
    READ_CONTROL = 0x020000,
 
    WRITE_DAC = 0x040000,
 
    WRITE_OWNER = 0x080000,
 
    SYNCHRONIZE = 0x100000,
 
    STANDARD_RIGHTS_ALL = DELETE | READ_CONTROL | WRITE_DAC | WRITE_OWNER | SYNCHRONIZE,
 
    STANDARD_RIGHTS_READ = READ_CONTROL,
 
    STANDARD_RIGHTS_WRITE = READ_CONTROL,
 
    STANDARD_RIGHTS_EXECUTE = READ_CONTROL,
 
    STANDARD_RIGHTS_REQUIRED = DELETE | READ_CONTROL | WRITE_DAC | WRITE_OWNER,
 
    ACCESS_SYSTEM_SECURITY = 0x1000000,
 
    GENERIC_ALL = 0x10000000,
    GENERIC_EXECUTE = 0x20000000,
    GENERIC_WRITE = 0x40000000,
    GENERIC_READ = 0x80000000,
 
    MAXIMUM_ALLOWED = 0x02000000,
};
 
class ACCESS_MASK {
  public:
    enum AccessMaskType {
        DirectoryAccessMask,
        EventAccessMask,
        FileAccessMask,
        KeyAccessMask,
        MutantAccessMask,
        ProcessAccessMask,
        SectionAccessMask,
        ThreadAccessMask,
        TokenAccessMask,
        UnknownAccessMaskType = -1
    };
 
    virtual AccessMaskType type() const { return UnknownAccessMaskType; }
 
    Json::Value json() const {
        Json::Value result;
        // TODO: Add in the actual flags (depends on type)
        result["value"] = value_;
        return result;
    }
 
    operator Json::Value() const { return json(); }
 
    inline uint32_t value() const { return value_; }
 
    inline operator uint32_t() const { return value_; }
 
    inline void value(uint32_t mask) { value_ = mask; }
 
    inline bool has(AccessMaskFlag flag) const { return (value() & flag) == flag; }
 
    inline void set(AccessMaskFlag flag) { value(value() | flag); }
 
    inline void clear(AccessMaskFlag flag) { value(value() & ~flag); }
 
    // Constructors and assignment operators
    ACCESS_MASK() = default;
    ACCESS_MASK(uint32_t mask) : value_(mask) {}
 
    ACCESS_MASK(const ACCESS_MASK&) = default;
    ACCESS_MASK& operator=(const ACCESS_MASK&) = default;
 
    virtual ~ACCESS_MASK() = default;
 
  private:
    uint32_t value_ = 0;
};
 
const std::string& to_string(AccessMaskFlag);
std::ostream& operator<<(std::ostream&, AccessMaskFlag);
 
std::string to_string(ACCESS_MASK);
std::ostream& operator<<(std::ostream&, ACCESS_MASK);
 
} // namespace nt
} // namespace windows
} // namespace introvirt