coordinator.contribute Namespace Reference

Functions
None	upload_response (Client client, str response_file, str key_file)
None	wait_for_turn (Client client, int interval, VerificationKey verification_key)
None	contribute (str base_url, str key_file, str challenge_file, Callable[[], str] contribute_cb, int wait_interval, Optional[str] server_certificate, bool insecure)

Function Documentation

contribute()

None coordinator.contribute.contribute	(	str	base_url,
		str	key_file,
		str	challenge_file,
		Callable[[], str]	contribute_cb,
		int	wait_interval,
		Optional[str]	server_certificate,
		bool	insecure
	)

Given a callback that creates a response from a challenge, download a
challenge, create the response via the callback, and sign and upload it.

Definition at line 65 of file contribute.py.

def contribute(
        base_url: str,
        key_file: str,
        challenge_file: str,
        contribute_cb: Callable[[], str],
        wait_interval: int,
        server_certificate: Optional[str],
        insecure: bool) -> None:
    """
    Given a callback that creates a response from a challenge, download a
    challenge, create the response via the callback, and sign and upload it.
    """
    # Check key upfront
    with open(key_file, "rb") as key_f:
        sk = import_signing_key(key_f.read())
    print("Got key")
 
    client = Client(base_url, server_certificate, insecure)
 
    try:
        if wait_interval:
            verification_key = get_verification_key(sk)
            wait_for_turn(client, wait_interval, verification_key)
 
        # Get challenge
        client.get_challenge(challenge_file)
        print("Got challenge")
 
        # Perform the contribution
        response_file = contribute_cb()
 
    except RequestException as err:
        print(f"EXCEPTION: {err.response.status_code} - {err.response.text}")
        raise
 
    # Sign and upload
    _upload_response(client, response_file, sk)

Here is the call graph for this function:

Here is the caller graph for this function:

upload_response()

None coordinator.contribute.upload_response	(	Client	client,
		str	response_file,
		str	key_file
	)

Given some response file and a key, sign the response and upload the
coordinator connected to by client.

Definition at line 31 of file contribute.py.

def upload_response(client: Client, response_file: str, key_file: str) -> None:
    """
    Given some response file and a key, sign the response and upload the
    coordinator connected to by client.
    """
    with open(key_file, "rb") as key_f:
        sk = import_signing_key(key_f.read())
    _upload_response(client, response_file, sk)
 
 

Here is the call graph for this function:

wait_for_turn()

None coordinator.contribute.wait_for_turn	(	Client	client,
		int	interval,
		VerificationKey	verification_key
	)

Wait until our turn, returning when we can contribute. If anything goes
wrong, an exception is thrown.

Definition at line 41 of file contribute.py.

def wait_for_turn(
        client: Client,
        interval: int,
        verification_key: VerificationKey) -> None:
    """
    Wait until our turn, returning when we can contribute. If anything goes
    wrong, an exception is thrown.
    """
    contributors = client.get_contributors()
    our_idx = contributors.get_contributor_index(verification_key)
    while True:
        state = client.get_state()
        current_index = state.next_contributor_index
        if our_idx is None:
            raise Exception("contributor is not in the server list")
        if our_idx < current_index:
            raise Exception("contributor turn has passed")
        if our_idx == current_index:
            return
        # Wait for interval and try again
        print(f"Waiting ... (current_idx: {current_index}, our_idx: {our_idx})")
        time.sleep(interval)
 
 

Here is the caller graph for this function: