password.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Crypto.
 *
 * StormByte-Crypto original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Crypto source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, in particular Crypto++, bundled libbzip2, the StormByte-Buffer
 * tree and the StormByte suite it vendors), which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Crypto is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Crypto. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/byte_size.hxx>
#include <StormByte/crypto/visibility.h>
#include <StormByte/size.hxx>
 
#include <memory>
#include <string>
#include <utility>
 
namespace StormByte::Crypto::Helpers {
    struct SecureContent;
    struct PasswordAccess;
}
 
namespace StormByte {
    namespace Crypto {
        namespace Secure {
            class STORMBYTE_CRYPTO_PUBLIC Password {
                public:
                    explicit Password(std::string& value) noexcept;
 
                    explicit Password(const char* value) noexcept;
 
                    Password(const void* data, StormByte::ByteSize size) noexcept;
 
                    Password(const Password& other);
 
                    Password(Password&& other) noexcept;
 
                    ~Password();
 
                    Password& operator=(const Password& other);
 
                    Password& operator=(Password&& other) noexcept;
                    StormByte::ByteSize Size() const noexcept;
 
                    bool Empty() const noexcept;
 
                    explicit operator bool() const noexcept;
 
                    bool operator==(const Password& other) const noexcept;
 
                    bool operator!=(const Password& other) const noexcept;
 
                private:
                    friend struct Helpers::PasswordAccess;
 
                    std::shared_ptr<Helpers::SecureContent> m_data; 
            };
        }
    }
}