QKDSimkit package

Subpackages

• QKDSimkit.core package
  • alice module
  • bob module
  • channel module
  • channel_features module
  • models module
  • node module
  • qexceptions module
  • receiver module
  • sender module
  • utils module
  • Module contents

Channel module

This module contains channel’s interface

QKDSimkit.Channel.manage_args()

Manages possible arguments and provides help messages

QKDSimkit.Channel.start_channel(address: str, noise: float, eve: bool)

Starts channel

Parameters

• address (str) – where to bind the channel

• noise (float) – ratio of noise in channel

• eve (bool) – simulate an eavesdropper in channel

Client module

This module contains client’s procedure to retrieve keys

QKDSimkit.Client.get_key(alice_address: str, channel_address: str, password: str, number: int, size: int)

Runs handshake and starts bob procedure

Parameters

• alice_address (str) – address of server

• channel_address (str) – address of channel

• token (str) – pre shared token

• number (int) – number of keys

• size (int) – size of keys (bits)

QKDSimkit.Client.start_client(alice_address, channel_address, number, size, password, show_keys)

Wrapper for get_key()

Parameters

• alice_address (str) – address of server

• channel_address (str) – address of channel

• number (int) – number of keys

• size (int) – size of keys (bits)

Server module

This module contains server’s APIs and method to run it

async QKDSimkit.Server.add_user(token: str)

Saves a token and its hash in memory

Parameters

token (str) – token representing a user

async QKDSimkit.Server.cache_get(key: str)

Retrieve a value from cache

Parameters

key (str) – key

async QKDSimkit.Server.cache_set(key: str, value)

Save a value in cahce

Parameters

• key (str) – key

• value – value

async QKDSimkit.Server.filter_get_key(request: Request, call_next)

QKDSimkit.Server.get_key_cli(id)

Synchronous wrapper for get_key

Returns

list of keys for the given ID

Return type

keys

async QKDSimkit.Server.getkey(password: Optional[str] = None)

Retrieves keys from server

Parameters

password (str) – hashed token

async QKDSimkit.Server.root(number: int, size: int, hashed: str, hash_proof: str, background_tasks: BackgroundTasks)

Checks handshake and starts alice

Parameters

• number (int) – number of keys

• size (int) – size of keys (bits)

• hashed (str) – identifier (hash of token)

• hash_proof (str) – hash of proof message

• background_tasks – background tasks

async QKDSimkit.Server.start_alice(number: int, size: int, ID: str)

Imports keys from an alice node, saves keys in memory

Parameters

• number (int) – number of keys

• size (int) – size of keys (bits)

• ID (str) – identifier (hash of token)

QKDSimkit.Server.start_server(channel_address, address)

Starts server and connect to an external channel

Parameters

• channel_address (str) – address of channel

• address (str) – where to bind this server

QKDSimkit.Server.start_server_and_channel(channel_address: str, noise: float, eve: bool, address: str)

Starts both server and channel

Returns

address of channel noise (float): ratio of noise in channel eve (bool): simulate an eavesdropper in channel address (str): where to bind this server

Return type

channel_address (str)

p2p_servers module

This module contains methods to operate a p2p node

async QKDSimkit.p2p_servers.answer_get(number: int, size: int, ID: str, type: str)

Starts a node

Parameters

• number (int) – number of keys

• size (int) – size of keys (bits)

• ID (str) – identifier of a pair of nodes

• type (str) – alice or bob (sender or receiver)

Returns

keys

QKDSimkit.p2p_servers.manage_args()

Manages possible arguments and provides help messages

async QKDSimkit.p2p_servers.root(number: int = 1, size: int = 256, ID: str = 'id')

http request handler for bob

Parameters

• number (int) – number of keys

• size (int) – size of keys (bits)

• ID (str) – identifier of a pair of nodes

Returns

keys

QKDSimkit.p2p_servers.start_p2p(node: str, address: str, channel_address: str)

Starts server

Parameters

• node (str) – type of node [alice, bob]

• address (str) – where to bind socket

cli module

This module contains the command line interface

QKDSimkit.cli.cli()

Command line interface single entry point for server, client, channel and peer to peer node

Module contents