dk.alexandra.fresco.suite.spdz.configuration.SpdzConfiguration.java Source code

Introduction

Here is the source code for dk.alexandra.fresco.suite.spdz.configuration.SpdzConfiguration.java

Source

/*******************************************************************************
 * Copyright (c) 2015 FRESCO (http://github.com/aicis/fresco).
 *
 * This file is part of the FRESCO project.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * FRESCO uses SCAPI - http://crypto.biu.ac.il/SCAPI, Crypto++, Miracl, NTL,
 * and Bouncy Castle. Please see these projects for any further licensing issues.
 *******************************************************************************/
package dk.alexandra.fresco.suite.spdz.configuration;

import java.util.Properties;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.ParseException;

import dk.alexandra.fresco.framework.sce.configuration.ProtocolSuiteConfiguration;
import dk.alexandra.fresco.framework.sce.configuration.SCEConfiguration;

public interface SpdzConfiguration extends ProtocolSuiteConfiguration {

    /**
     * Gets an approximation of the maximum bit length of any number appearing 
     * in an application. This is used by certain protocols, e.g., to avoid overflow 
     * when working in a Z_p field. 
     * TODO: Consider factoring out of the configuration as this is really specific
     * only to certain protocols.
     * @return the expected maximum bit length of any number appearing in the application.
     */
    int getMaxBitLength();

    /**
     * The path to where preprocessed data is located, including the triples
     * used for e.g. multiplication.
     * 
     * @return
     */
    public String getTriplePath();

    /**
     * True: system will use dummy data for preprocessed data.
     * False: System will read data from the FRESCO native storage.
     * @return
     */
    public boolean useDummyData();

    static SpdzConfiguration fromCmdLine(SCEConfiguration sceConf, CommandLine cmd) throws ParseException {
        Properties p = cmd.getOptionProperties("D");
        //TODO: Figure out a meaningful default for the below 
        final int maxBitLength = Integer.parseInt(p.getProperty("spdz.maxBitLength", "64"));
        if (maxBitLength < 2) {
            throw new ParseException("spdz.maxBitLength must be > 1");
        }
        final String triplePath = p.getProperty("spdz.triplePath", "/triples");
        final boolean useDummyData = Boolean.parseBoolean(p.getProperty("spdz.useDummyData", "False"));

        return new SpdzConfiguration() {

            @Override
            public String getTriplePath() {
                return triplePath;
            }

            @Override
            public int getMaxBitLength() {
                return maxBitLength;
            }

            @Override
            public boolean useDummyData() {
                return useDummyData;
            }
        };
    }

}