accesstoken/src/atm_command.cpp

/*
 * Copyright (c) 2022-2024 Huawei Device Co., Ltd.
 * 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.
 */

#include "atm_command.h"

#include <getopt.h>
#include <string>

#include "access_token_error.h"
#include "accesstoken_kit.h"
#include "privacy_kit.h"
#include "to_string.h"

namespace OHOS {
namespace Security {
namespace AccessToken {
namespace {
static constexpr int32_t MAX_COUNTER = 1000;
static constexpr int32_t MIN_ARGUMENT_NUMBER = 2;
static constexpr int32_t MAX_ARGUMENT_NUMBER = 4096;
static const std::string HELP_MSG_NO_OPTION = "error: you must specify an option at least.\n";
static const std::string SHORT_OPTIONS_DUMP = "d::h::t::r::v::i:p:b:n:";
static const std::string TOOLS_NAME = "atm";
static const std::string HELP_MSG =
    "usage: atm <command> <option>\n"
    "These are common atm commands list:\n"
    "  help    list available commands\n"
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
    "  perm    grant/cancel permission\n"
    "  toggle  set/get toggle request/record status\n"
#endif
    "  dump    dump system command\n";

static const std::string HELP_MSG_DUMP =
    "usage: atm dump <option>.\n"
    "options list:\n"
    "  -d, --definition [-p <permission-name>]                  list all permission definitions in system\n"
    "  -h, --help                                               list available options\n"
    "  -t, --all                                                list all name of token info in system\n"
    "  -t, --token-info -i <token-id>                           list single token info by specific tokenId\n"
    "  -t, --token-info -b <bundle-name>                        list all token info by specific bundleName\n"
    "  -t, --token-info -n <process-name>                       list single token info by specific native processName\n"
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
    "  -r, --record-info [-i <token-id>] [-p <permission-name>] list used records in system\n"
#endif
    "  -v, --visit-type [-i <token-id>] [-p <permission-name>]  list all token used type in system\n";

static const std::string HELP_MSG_PERM =
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
    "usage: atm perm <option>.\n"
    "options list:\n"
    "  -h, --help                                       list available options\n"
    "  -g, --grant -i <token-id> -p <permission-name>   grant a permission by a specified token-id\n"
    "  -c, --cancel -i <token-id> -p <permission-name>  cancel a permission by a specified token-id\n";
#else
    "";
#endif

static const std::string HELP_MSG_TOGGLE =
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
    "usage: atm toggle request <option>.\n"
    "options list:\n"
    "  -h, --help                                                  list available options\n"
    "  -r -s, --set -i <user-id> -p <permission-name> -k <status>  set request status by specified user-id and perm\n"
    "  -r -o, --get -i <user-id> -p <permission-name>              get request status by specified user-id and perm\n"
    "  -u -s, --set -i <user-id> -k <status>                       set record status by a specified user-id\n"
    "  -u -o, --get -i <user-id>                                   get record status by a specified user-id\n"
    "  <status>                                                    0 is closed, 1 is open\n";
#else
    "";
#endif

static const struct option LONG_OPTIONS_DUMP[] = {
    {"definition", no_argument, nullptr, 'd'},
    {"help", no_argument, nullptr, 'h'},
    {"token-info", no_argument, nullptr, 't'},
    {"record-info", no_argument, nullptr, 'r'},
    {"token-id", required_argument, nullptr, 'i'},
    {"permission-name", required_argument, nullptr, 'p'},
    {"bundle-name", required_argument, nullptr, 'b'},
    {"process-name", required_argument, nullptr, 'n'},
    {nullptr, 0, nullptr, 0}
};

static const std::string SHORT_OPTIONS_PERM = "hg::c::i:p:";
static const struct option LONG_OPTIONS_PERM[] = {
    {"help", no_argument, nullptr, 'h'},
    {"grant", no_argument, nullptr, 'g'},
    {"cancel", no_argument, nullptr, 'c'},
    {"token-id", required_argument, nullptr, 'i'},
    {"permission-name", required_argument, nullptr, 'p'},
    {nullptr, 0, nullptr, 0}
};

static const std::string SHORT_OPTIONS_TOGGLE = "hr::u::s::o::i:p:k:";
static const struct option LONG_OPTIONS_TOGGLE[] = {
    {"help", no_argument, nullptr, 'h'},
    {"request", no_argument, nullptr, 'r'},
    {"record", no_argument, nullptr, 'u'},
    {"set", no_argument, nullptr, 's'},
    {"get", no_argument, nullptr, 'o'},
    {"user-id", required_argument, nullptr, 'i'},
    {"permission-name", required_argument, nullptr, 'p'},
    {"status", required_argument, nullptr, 'k'},
    {nullptr, 0, nullptr, 0}
};

std::map<char, OptType> COMMAND_TYPE = {
    {'d', DUMP_PERM},
    {'t', DUMP_TOKEN},
    {'r', DUMP_RECORD},
    {'v', DUMP_TYPE},
    {'g', PERM_GRANT},
    {'c', PERM_REVOKE},
    {'s', TOGGLE_SET},
    {'o', TOGGLE_GET},
};

std::map<char, ToggleModeType> TOGGLE_MODE_TYPE = {
    {'r', TOGGLE_REQUEST},
    {'u', TOGGLE_RECORD},
};
}

AtmCommand::AtmCommand(int32_t argc, char *argv[]) : argc_(argc), argv_(argv), name_(TOOLS_NAME)
{
    opterr = 0;

    commandMap_ = {
        {"help", [this](){return RunAsHelpCommand();}},
        {"dump", [this]() {return RunAsCommonCommand();}},
        {"perm", [this]() {return RunAsCommonCommand();}},
        {"toggle", [this]() {return RunAsCommonCommand();}},
    };

    if ((argc < MIN_ARGUMENT_NUMBER) || (argc > MAX_ARGUMENT_NUMBER)) {
        cmd_ = "help";

        return;
    }

    cmd_ = argv[1];

    for (int32_t i = 2; i < argc; i++) {
        argList_.push_back(argv[i]);
    }
}

std::string AtmCommand::GetCommandErrorMsg() const
{
    std::string commandErrorMsg =
        name_ + ": '" + cmd_ + "' is not a valid " + name_ + " command. See '" + name_ + " help'.\n";

    return commandErrorMsg;
}

std::string AtmCommand::ExecCommand()
{
    auto respond = commandMap_[cmd_];
    if (respond == nullptr) {
        resultReceiver_.append(GetCommandErrorMsg());
    } else {
        respond();
    }

    return resultReceiver_;
}

int32_t AtmCommand::RunAsHelpCommand()
{
    resultReceiver_.append(HELP_MSG);

    return RET_SUCCESS;
}

int32_t AtmCommand::RunAsCommandError(void)
{
    int32_t result = RET_SUCCESS;

    if ((optind < 0) || (optind >= argc_)) {
        return ERR_INVALID_VALUE;
    }

    // When scanning the first argument
    if (strcmp(argv_[optind], cmd_.c_str()) == 0) {
        // 'atm dump' with no option: atm dump
        // 'atm dump' with a wrong argument: atm dump xxx

        resultReceiver_.append(HELP_MSG_NO_OPTION + "\n");
        result = ERR_INVALID_VALUE;
    }
    return result;
}

std::string AtmCommand::GetUnknownOptionMsg() const
{
    std::string result;

    if ((optind < 0) || (optind > argc_)) {
        return result;
    }

    result.append("error: unknown option\n.");

    return result;
}

int32_t AtmCommand::RunAsCommandMissingOptionArgument(void)
{
    int32_t result = RET_SUCCESS;
    switch (optopt) {
        case 'h':
            // 'atm dump -h'
            result = ERR_INVALID_VALUE;
            break;
        case 'i':
        case 'p':
        case 'g':
        case 'c':
            resultReceiver_.append("error: option ");
            resultReceiver_.append("requires a value.\n");
            result = ERR_INVALID_VALUE;
            break;
        default: {
            std::string unknownOptionMsg = GetUnknownOptionMsg();

            resultReceiver_.append(unknownOptionMsg);
            result = ERR_INVALID_VALUE;
            break;
        }
    }
    return result;
}

void AtmCommand::RunAsCommandExistentOptionArgument(const int32_t& option, AtmToolsParamInfo& info)
{
    switch (option) {
        case 'd':
        case 't':
        case 'r':
        case 'v':
        case 'g':
        case 'c':
            info.type = COMMAND_TYPE[option];
            break;
        case 'i':
            if (optarg != nullptr) {
                info.tokenId = static_cast<AccessTokenID>(std::atoi(optarg));
            }
            break;
        case 'p':
            if (optarg != nullptr) {
                info.permissionName = optarg;
            }
            break;
        case 'b':
            if (optarg != nullptr) {
                info.bundleName = optarg;
            }
            break;
        case 'n':
            if (optarg != nullptr) {
                info.processName = optarg;
            }
            break;
        default:
            break;
    }
}

void AtmCommand::RunToggleCommandExistentOptionArgument(const int32_t& option, AtmToolsParamInfo& info)
{
    switch (option) {
        case 'r':
        case 'u':
            info.toggleMode = TOGGLE_MODE_TYPE[option];
            break;
        case 's':
        case 'o':
            info.type = COMMAND_TYPE[option];
            break;
        case 'p':
            if (optarg != nullptr) {
                info.permissionName = optarg;
            }
            break;
        case 'i':
            if (optarg != nullptr) {
                if (IsNumericString(optarg)) {
                    info.userID = static_cast<int32_t>(std::atoi(optarg));
                } else {
                    info.userID = -1;
                }
            }
            break;
        case 'k':
            if (optarg != nullptr && (strcmp(optarg, "0") == 0 || strcmp(optarg, "1") == 0)) {
                info.status = static_cast<uint32_t>(std::atoi(optarg));
            }
            break;
        default:
            break;
    }
}

bool AtmCommand::IsNumericString(const char* string)
{
    if (string == nullptr || string[0] == '\0') {
        return false;
    }

    for (int32_t i = 0; string[i] != '\0'; i++) {
        if (!isdigit(string[i])) {
            return false;
        }
    }

    return true;
}

std::string AtmCommand::DumpRecordInfo(uint32_t tokenId, const std::string& permissionName)
{
    PermissionUsedRequest request;
    request.tokenId = tokenId;
    request.flag = FLAG_PERMISSION_USAGE_DETAIL;
    if (!permissionName.empty()) {
        request.permissionList.emplace_back(permissionName);
    }

    PermissionUsedResult result;
    if (PrivacyKit::GetPermissionUsedRecords(request, result) != 0) {
        return "";
    }

    std::string dumpInfo;
    ToString::PermissionUsedResultToString(result, dumpInfo);
    return dumpInfo;
}

std::string AtmCommand::DumpUsedTypeInfo(uint32_t tokenId, const std::string& permissionName)
{
    std::vector<PermissionUsedTypeInfo> results;
    if (PrivacyKit::GetPermissionUsedTypeInfos(tokenId, permissionName, results) != 0) {
        return "";
    }

    std::string dumpInfo;
    for (const auto& result : results) {
        ToString::PermissionUsedTypeInfoToString(result, dumpInfo);
    }

    return dumpInfo;
}

int32_t AtmCommand::ModifyPermission(const OptType& type, AccessTokenID tokenId, const std::string& permissionName)
{
    if ((tokenId == 0) || (permissionName.empty())) {
        return ERR_INVALID_VALUE;
    }

    int32_t result = 0;
    if (type == PERM_GRANT) {
        result = AccessTokenKit::GrantPermission(tokenId, permissionName, PERMISSION_USER_FIXED);
    } else if (type == PERM_REVOKE) {
        result = AccessTokenKit::RevokePermission(tokenId, permissionName, PERMISSION_USER_FIXED);
    } else {
        return ERR_INVALID_VALUE;
    }
    return result;
}

int32_t AtmCommand::SetToggleStatus(int32_t userID, const std::string& permissionName, const uint32_t& status)
{
    if ((userID < 0) || (permissionName.empty()) ||
        ((status != PermissionRequestToggleStatus::OPEN) &&
         (status != PermissionRequestToggleStatus::CLOSED))) {
        return ERR_INVALID_VALUE;
    }

    return AccessTokenKit::SetPermissionRequestToggleStatus(permissionName, status, userID);
}

int32_t AtmCommand::GetToggleStatus(int32_t userID, const std::string& permissionName, std::string& statusInfo)
{
    if ((userID < 0) || (permissionName.empty())) {
        return ERR_INVALID_VALUE;
    }

    uint32_t status;
    int32_t result = AccessTokenKit::GetPermissionRequestToggleStatus(permissionName, status, userID);
    if (result != RET_SUCCESS) {
        return result;
    }

    if (status == PermissionRequestToggleStatus::OPEN) {
        statusInfo = "Toggle status is open";
    } else {
        statusInfo = "Toggle status is closed";
    }

    return result;
}

int32_t AtmCommand::RunCommandByOperationType(const AtmToolsParamInfo& info)
{
    std::string dumpInfo;
    int32_t ret = RET_SUCCESS;
    switch (info.type) {
        case DUMP_PERM:
            AccessTokenKit::DumpTokenInfo(info, dumpInfo);
            break;
        case DUMP_TOKEN:
            AccessTokenKit::DumpTokenInfo(info, dumpInfo);
            break;
        case DUMP_RECORD:
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
            dumpInfo = DumpRecordInfo(info.tokenId, info.permissionName);
#endif
            break;
        case DUMP_TYPE:
            dumpInfo = DumpUsedTypeInfo(info.tokenId, info.permissionName);
            break;
        case PERM_GRANT:
        case PERM_REVOKE:
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
            ret = ModifyPermission(info.type, info.tokenId, info.permissionName);
            dumpInfo = (ret == RET_SUCCESS) ? "Success" : "Failure";
#endif
            break;
        default:
            resultReceiver_.append("error: miss option \n");
            return ERR_INVALID_VALUE;
    }
    resultReceiver_.append(dumpInfo + "\n");
    return ret;
}

int32_t AtmCommand::SetRecordToggleStatus(int32_t userID, const uint32_t& recordStatus, std::string& statusInfo)
{
    if ((userID < 0)) {
        statusInfo = "Invalid userID\n";
        return ERR_INVALID_VALUE;
    }

    if ((recordStatus != 0) && (recordStatus != 1)) {
        statusInfo = "Invalid status\n";
        return ERR_INVALID_VALUE;
    }

    bool status = (recordStatus == 1);

    return PrivacyKit::SetPermissionUsedRecordToggleStatus(userID, status);
}

int32_t AtmCommand::GetRecordToggleStatus(int32_t userID, std::string& statusInfo)
{
    if ((userID < 0)) {
        statusInfo = "Invalid userID\n";
        return ERR_INVALID_VALUE;
    }

    bool status = true;
    int32_t result = PrivacyKit::GetPermissionUsedRecordToggleStatus(userID, status);
    if (result != RET_SUCCESS) {
        return result;
    }

    statusInfo = status ? "Record toggle status is open \n" : "Record toggle status is closed \n";

    return result;
}

int32_t AtmCommand::HandleToggleRequest(const AtmToolsParamInfo& info, std::string& dumpInfo)
{
    int32_t ret = RET_SUCCESS;

    switch (info.type) {
        case TOGGLE_SET:
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
            ret = SetToggleStatus(info.userID, info.permissionName, info.status);
            dumpInfo = (ret == RET_SUCCESS) ? "Success" : "Failure";
#endif
            break;
        case TOGGLE_GET:
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
            ret = GetToggleStatus(info.userID, info.permissionName, dumpInfo);
            if (ret != RET_SUCCESS) {
                dumpInfo = "Failure";
            }
#endif
            break;
        default:
            resultReceiver_.append("error: miss option \n");
            return ERR_INVALID_VALUE;
        }

    return ret;
}

int32_t AtmCommand::HandleToggleRecord(const AtmToolsParamInfo& info, std::string& dumpInfo)
{
    int32_t ret = RET_SUCCESS;

    switch (info.type) {
        case TOGGLE_SET:
 #ifndef ATM_BUILD_VARIANT_USER_ENABLE
            ret = SetRecordToggleStatus(info.userID, info.status, dumpInfo);
            dumpInfo += (ret == RET_SUCCESS) ? "Success" : "Failure";
#endif
            break;
        case TOGGLE_GET:
#ifndef ATM_BUILD_VARIANT_USER_ENABLE
            ret = GetRecordToggleStatus(info.userID, dumpInfo);
            dumpInfo += (ret == RET_SUCCESS) ? "Success" : "Failure";
#endif
            break;
        default:
            resultReceiver_.append("error: miss option \n");
            return ERR_INVALID_VALUE;
    }

    return ret;
}

int32_t AtmCommand::RunToggleCommandByOperationType(const AtmToolsParamInfo& info)
{
    std::string dumpInfo;
    int32_t ret = RET_SUCCESS;

    switch (info.toggleMode) {
        case TOGGLE_REQUEST:
            ret = HandleToggleRequest(info, dumpInfo);
            break;
        case TOGGLE_RECORD:
            ret = HandleToggleRecord(info, dumpInfo);
            break;
        default:
            resultReceiver_.append("error: unspecified toggle mode \n");
            return ERR_INVALID_VALUE;
    }

    resultReceiver_.append(dumpInfo + "\n");
    return ret;
}

int32_t AtmCommand::HandleComplexCommand(const std::string& shortOption, const struct option longOption[],
    const std::string& helpMsg)
{
    int32_t result = RET_SUCCESS;
    AtmToolsParamInfo info;
    int32_t counter = 0;

    while (true) {
        counter++;
        int32_t option = getopt_long(argc_, argv_, shortOption.c_str(), longOption, nullptr);
        if ((optind < 0) || (optind > argc_)) {
            return ERR_INVALID_VALUE;
        }

        if (option == -1) {
            if (counter == 1) {
                result = RunAsCommandError();
            }
            break;
        }

        if (option == '?') {
            result = RunAsCommandMissingOptionArgument();
            break;
        }

        if (option == 'h') {
            // 'atm dump -h'
            result = ERR_INVALID_VALUE;
            continue;
        }
        RunAsCommandExistentOptionArgument(option, info);
    }

    if (result != RET_SUCCESS) {
        resultReceiver_.append(helpMsg + "\n");
    } else {
        result = RunCommandByOperationType(info);
    }
    return result;
}

int32_t AtmCommand::HandleToggleCommand(const std::string& shortOption, const struct option longOption[],
    const std::string& helpMsg)
{
    int32_t result = RET_SUCCESS;
    AtmToolsParamInfo info;
    int32_t counter = 0;

    while (counter < MAX_COUNTER) {
        counter++;
        int32_t option = getopt_long(argc_, argv_, shortOption.c_str(), longOption, nullptr);
        if ((optind < 0) || (optind > argc_)) {
            return ERR_INVALID_VALUE;
        }

        if (option == -1) {
            if (counter == 1) {
                result = RunAsCommandError();
            }
            break;
        }

        if (option == '?') {
            result = RunAsCommandMissingOptionArgument();
            break;
        }

        if (option == 'h') {
            // 'atm dump -h'
            result = ERR_INVALID_VALUE;
            continue;
        }
        RunToggleCommandExistentOptionArgument(option, info);
    }

    if (result != RET_SUCCESS) {
        resultReceiver_.append(helpMsg + "\n");
    } else {
        result = RunToggleCommandByOperationType(info);
    }
    return result;
}

int32_t AtmCommand::RunAsCommonCommand()
{
    if (cmd_ == "dump") {
        return HandleComplexCommand(SHORT_OPTIONS_DUMP, LONG_OPTIONS_DUMP, HELP_MSG_DUMP);
    } else if (cmd_ == "perm") {
        return HandleComplexCommand(SHORT_OPTIONS_PERM, LONG_OPTIONS_PERM, HELP_MSG_PERM);
    } else if (cmd_ == "toggle") {
        return HandleToggleCommand(SHORT_OPTIONS_TOGGLE, LONG_OPTIONS_TOGGLE, HELP_MSG_TOGGLE);
    }

    return ERR_PARAM_INVALID;
}
} // namespace AccessToken
} // namespace Security
} // namespace OHOS