qkd-key.h

Go to the documentation of this file.

 
 
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 DOTFEESA www.tk.etf.unsa.ba
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author:  Emir Dervisevic <emir.dervisevic@etf.unsa.ba>
 *          Miralem Mehic <miralem.mehic@ieee.org>
 */
#ifndef QKD_KEY_H
#define QKD_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 <time.h>
#include "ns3/nstime.h"
#include "ns3/traced-callback.h"
#include "ns3/random-variable-stream.h"
#include "ns3/deprecated.h"
#include <string>
#include <iomanip>
#include <vector>
#include <bitset>
/*
#include <crypto++/iterhash.h>
#include <crypto++/secblock.h>
*/
namespace ns3 {
 
class QKDKey : public Object
{
    public:
 
        enum QKDKeyState_e {
            INIT,
            READY,
            SERVED,
            TRANSFORMED,
            USED,
            OBSOLETE,
            RESTORED,
            RESERVED
        };
 
        static TypeId GetTypeId (void);
 
        QKDKey (uint64_t keySize); 
 
        QKDKey (std::string keyId, uint64_t keyIdnum, uint64_t keySize); 
 
        QKDKey (std::string keyId, uint64_t keyIdnum, std::string key);
 
        QKDKey (std::string keyId, std::string key); //KMS key generation!
 
        std::string        GetId (void) const;
 
        void               SetId (std::string value);
 
        Ptr<QKDKey>     Copy (void) const; 
 
        uint8_t *       GetKey (void); 
 
        std::string     GetKeyString (void);
 
        std::string GetKeyBinary();
 
        uint64_t        GetSize(void) const;
 
        uint64_t        GetSizeInBits(void) const;
 
        void            SetSize(uint64_t sizeInBytes);
 
        void            MarkReady();
 
        void            MarkUsed();
 
        void            MarkRestored();
 
        void            MarkServed();
 
        void            MarkReserved();
 
        void            MarkTransformed();
 
        std::string     ConsumeKeyString (void);
 
        std::string     ToString (void);
 
        std::string     GenerateRandomString(const int len);
 
        QKDKeyState_e GetState () const; 
 
        std::string GetStateString () const;
 
        static std::string GetStateString (QKDKeyState_e state);
 
        void SwitchToState (QKDKeyState_e state);
 
        Time GetKeyTimestamp();
 
        ns3::TracedCallback<const std::string &, const std::string &> m_stateTransitionTrace;
 
    private:
        uint64_t            m_internalID; //<! The internal key identifier.
        std::string         m_id;       //<! The key identifier.
        static uint64_t     m_globalUid; //<! The global static key identifier.
        uint64_t            m_sizeInBytes; //<! The key size in bytes.
        uint64_t            m_sizeInBits; //<! The key size in bits.
        std::string         m_key;  //<! The key value.
        Time                m_timestamp; //<! The key timestamp. 
        QKDKeyState_e       m_state; 
        Ptr<UniformRandomVariable> m_random; //<! The uniform random variable.
        
    };
 
} // namespace ns3
 
#endif /* QKD_KEY_H */