coordinator.server_configuration.Configuration Class Reference

Public Member Functions
def	__init__ (self, str contributors_file, float start_time_utc, float contribution_interval, str tls_key, str tls_certificate, int port=5000, Optional[str] email_server=None, Optional[str] email_address=None, Optional[str] email_password_file=None)
str	to_json (self)
str	to_json_template (self)

Static Public Member Functions
Configuration	template ()
Configuration	from_json (str config_json)

Public Attributes
	port

Detailed Description

Static configuration provided at startup

Definition at line 19 of file server_configuration.py.

Constructor & Destructor Documentation

__init__()

def coordinator.server_configuration.Configuration.__init__	(		self,
		str	contributors_file,
		float	start_time_utc,
		float	contribution_interval,
		str	tls_key,
		str	tls_certificate,
		int	port = 5000,
		Optional[str]	email_server = None,
		Optional[str]	email_address = None,
		Optional[str]	email_password_file = None
	)

Definition at line 23 of file server_configuration.py.

    def __init__(
            self,
            contributors_file: str,
            start_time_utc: float,
            contribution_interval: float,
            tls_key: str,
            tls_certificate: str,
            port: int = 5000,
            email_server: Optional[str] = None,
            email_address: Optional[str] = None,
            email_password_file: Optional[str] = None):
        if not contributors_file:
            raise Exception("no contributors file specified")
        if start_time_utc == 0.0:
            raise Exception("invalid start time")
        if (email_server or email_address or email_password_file) and \
           (not (email_server and email_address and email_password_file)):
            raise Exception(
                "must all or none of email server, address and password file " +
                "in config")
        if email_password_file and not exists(email_password_file):
            raise Exception(f"no email password file: {email_password_file}")
 
        self.contributors_file: str = contributors_file
        self.start_time_utc: float = float(start_time_utc)
        self.contribution_interval: float = float(contribution_interval)
        self.email_server: Optional[str] = email_server
        self.email_address: Optional[str] = email_address
        self.email_password_file: Optional[str] = email_password_file
        self.tls_key: str = tls_key
        self.tls_certificate: str = tls_certificate
        self.port = port
 

Member Function Documentation

from_json()

Configuration coordinator.server_configuration.Configuration.from_json ( str  config_json )

static

Definition at line 88 of file server_configuration.py.

    def from_json(config_json: str) -> Configuration:
        return Configuration._from_json_dict(json.loads(config_json))
 

template()

Configuration coordinator.server_configuration.Configuration.template ( )

static

Populate contributors field, and other fields with sensible defaults
for a configuration template.  All fields are expected to be
overridden.

Definition at line 57 of file server_configuration.py.

    def template() -> Configuration:
        """
        Populate contributors field, and other fields with sensible defaults
        for a configuration template.  All fields are expected to be
        overridden.
        """
        return Configuration(
            contributors_file="contributors.json",
            start_time_utc=time.time() + 6 * 60 * 60,
            contribution_interval=24 * 60 * 60,
            tls_key="key.pem",
            tls_certificate="cert.pem",
            port=5000,
            email_server="smtp.mymail.com:465",
            email_address="mpc_coordinator@mymail.com",
            email_password_file="password.txt")
 

to_json()

str coordinator.server_configuration.Configuration.to_json

(

self

)

Definition at line 74 of file server_configuration.py.

    def to_json(self) -> str:
        return json.dumps(self._to_json_dict(), indent=4)
 

Here is the call graph for this function:

to_json_template()

str coordinator.server_configuration.Configuration.to_json_template

(

self

)

For the case where ana administrator has a list of contributors (e.g.
from an online form) and keys and wants to import it into a
server_config.json file. This function writes the contributors
correctly, and places dummy data / descriptions in other fields,
prefixed with '_', for the admin to fill in later.

Definition at line 77 of file server_configuration.py.

    def to_json_template(self) -> str:
        """
        For the case where ana administrator has a list of contributors (e.g.
        from an online form) and keys and wants to import it into a
        server_config.json file. This function writes the contributors
        correctly, and places dummy data / descriptions in other fields,
        prefixed with '_', for the admin to fill in later.
        """
        return json.dumps(self._to_json_template_dict(), indent=4)
 

Here is the call graph for this function:

Member Data Documentation

port

coordinator.server_configuration.Configuration.port

Definition at line 44 of file server_configuration.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/mpc/coordinator/server_configuration.py