app-key.h

Go to the documentation of this file.

/*
 * Copyright(c) 2020 DOTFEESA www.tk.etf.unsa.ba
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 *
 *
 * Author:  Emir Dervisevic <emir.dervisevic@etf.unsa.ba>
 *          Miralem Mehic <miralem.mehic@ieee.org>
 */
#ifndef APP_KEY_H
#define APP_KEY_H
 
#include <stdint.h>
#include <algorithm>
#include <stdint.h>
 
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/callback.h"
#include "ns3/assert.h"
#include "ns3/ptr.h"
#include "ns3/simulator.h"
#include "ns3/nstime.h"
#include "ns3/traced-callback.h"
#include "ns3/deprecated.h"
#include "qkd-key.h"
 
 
namespace ns3 {
 
/**
 * @ingroup qkd
 * @brief The key at the application layer. It has lifetime and type attributes in addition
 * to QKD key class attributes.
 */
    class AppKey : public QKDKey {
        public:
 
            enum Type
            {
                ENCRYPTION,
                AUTHENTICATION
            };
 
            AppKey(
                std::string id,
                std::string value,
                Type type,
                uint32_t lifetime
            ) : QKDKey(id, value) {
                m_type = type;
                m_lifetime = lifetime;
 
            }
 
            AppKey(
                uint32_t index,
                std::string value,
                Type type,
                uint32_t lifetime
            ) : QKDKey("", value) {
                m_index = index;
                m_type = type;
                m_lifetime = lifetime;
            }
 
            uint32_t GetLifetime() const {
                return m_lifetime;
            }
 
            void SetLifetime(uint32_t lifetime) {
                m_lifetime = lifetime;
            }
 
            void UseLifetime(uint32_t amount) {
                if(m_lifetime >= amount)
                    m_lifetime -= amount;
                else
                    m_lifetime = 0;
            }
 
            Type GetType() const {
                return m_type;
            }
 
            void SetType(Type type) {
                m_type = type;
            }
 
            void SetIndex(uint32_t index){
                m_index = index;
            }
 
            uint32_t GetIndex() const {
                return m_index;
            }
 
 
        private:
 
            Type        m_type;     //<!Key type
            uint32_t    m_index;    //<!Key index(for ETSI 004 clients)
            uint32_t    m_lifetime; //<!Key lifetime value in bytes
 
    };
 
} // namespace ns3
 
#endif /* APP_KEY_H */