posix_access_rights.hpp🔗

Namespaces🔗

Name
iox building block to easily create free function for logging in a library context
iox::posix

Classes🔗

	Name
struct	iox::posix::PosixRights
class	iox::posix::PosixGroup
class	iox::posix::PosixUser

Source code🔗

// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_HOOFS_POSIX_WRAPPER_POSIX_ACCESS_RIGHTS_HPP
#define IOX_HOOFS_POSIX_WRAPPER_POSIX_ACCESS_RIGHTS_HPP

#include "iceoryx_hoofs/cxx/optional.hpp"
#include "iceoryx_hoofs/cxx/string.hpp"
#include "iceoryx_hoofs/cxx/vector.hpp"
#include "iceoryx_hoofs/platform/types.hpp"

#include <string>

namespace iox
{
namespace posix
{
static constexpr int MaxNumberOfGroups = 888;

struct PosixRights
{
    PosixRights(bool f_read, bool f_write, bool f_execute) noexcept;
    bool m_read;
    bool m_write;
    bool m_execute;
};

class PosixGroup
{
  public:
    using string_t = cxx::string<100>;
    explicit PosixGroup(const gid_t f_id) noexcept;
    explicit PosixGroup(const string_t& f_name) noexcept;

    bool operator==(const PosixGroup& other) const noexcept;

    string_t getName() const noexcept;
    gid_t getID() const noexcept;

    bool doesExist() const noexcept;

    static PosixGroup getGroupOfCurrentProcess() noexcept;

    static cxx::optional<uid_t> getGroupID(const string_t& f_name) noexcept;
    static cxx::optional<string_t> getGroupName(gid_t f_id) noexcept;

  private:
    gid_t m_id;
    bool m_doesExist{false};
};

class PosixUser
{
  public:
    using groupVector_t = cxx::vector<PosixGroup, MaxNumberOfGroups>;
    using string_t = cxx::string<100>;

    explicit PosixUser(const uid_t f_id) noexcept;
    explicit PosixUser(const string_t& f_name) noexcept;

    groupVector_t getGroups() const noexcept;
    string_t getName() const noexcept;
    uid_t getID() const noexcept;

    bool doesExist() const noexcept;

    static PosixUser getUserOfCurrentProcess() noexcept;

    static cxx::optional<uid_t> getUserID(const string_t& f_name) noexcept;
    static cxx::optional<string_t> getUserName(uid_t f_id) noexcept;

  private:
    uid_t m_id;
    bool m_doesExist{false};
};

} // namespace posix
} // namespace iox

#endif // IOX_HOOFS_POSIX_WRAPPER_POSIX_ACCESS_RIGHTS_HPP

Updated on 18 December 2023 at 13:02:35 CET