ch.epfl.dedis.calypso

Class CalypsoRPC

java.lang.Object

ch.epfl.dedis.byzcoin.ByzCoinRPC

ch.epfl.dedis.calypso.CalypsoRPC

public class CalypsoRPC
extends ByzCoinRPC

CalypsoRPC is the entry point for all the RPC calls to the Calypso service, which acts as the secret-management cothority.

Field Summary

Fields inherited from class ch.epfl.dedis.byzcoin.ByzCoinRPC

currentVersion

Constructor Summary

Constructors

Constructor and Description
CalypsoRPC(ByzCoinRPC byzcoin, DarcId darcBaseID, Roster ltsRoster, List<Signer> signers, List<Long> signerCtrs) Creates a new Long Term Secret on an existing ByzCoin ledger.

Method Summary

Modifier and Type	Method and Description
static void	authorize(ServerIdentity si, SkipblockId byzcoinId) Connect to a server to an Authorized ByzCoin ID.
CreateLTSReply	createLTS(Proof proof) Create a long-term-secret (LTS) and retrieve its configuration.
static CalypsoRPC	fromCalypso(ByzCoinRPC bc, LTSId ltsId) Connects to an existing Long Term Secret using a ByzCoinRPC.
static CalypsoRPC	fromCalypso(Roster roster, SkipblockId byzcoinId, LTSId ltsId) Connects to an existing byzcoin and an existing Long Term Secret.
CreateLTSReply	getLTS()
LTSId	getLTSId()
CreateLTSReply	getLTSReply(LTSId ltsId) returns the shared symmetricKey of the DKG that must be used to encrypt the symmetric encryption symmetricKey.
Point	getLTSX()
void	reshareLTS(Proof proof) Start a request to reshare the LTS.
DecryptKeyReply	tryDecrypt(Proof writeProof, Proof readProof) Ask the secret-management cothority for the decryption shares.

Methods inherited from class ch.epfl.dedis.byzcoin.ByzCoinRPC

checkAuthorization, checkLiveness, checkStateChangeValidity, fromByzCoin, getAllInstanceVersion, getBlock, getConfig, getGenesisBlock, getGenesisDarc, getGenesisDarcInstance, getInstanceVersion, getLastInstanceVersion, getLatestBlock, getProof, getRoster, getSignerCounters, getSkipchain, getSubscription, makeGenesisDarc, sendTransaction, sendTransactionAndWait, setBlockInterval, setMaxBlockSize, setRoster, subscribeSkipBlock, subscribeSkipBlock, toBytes, unsubscribeBlock, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalypsoRPC

public CalypsoRPC(ByzCoinRPC byzcoin,
                  DarcId darcBaseID,
                  Roster ltsRoster,
                  List<Signer> signers,
                  List<Long> signerCtrs)
           throws CothorityException

Creates a new Long Term Secret on an existing ByzCoin ledger.

Parameters:

byzcoin - the existing byzcoin ledger.

Throws:

CothorityException - if something goes wrong

Method Detail

getLTSReply

public CreateLTSReply getLTSReply(LTSId ltsId)
                           throws CothorityCommunicationException

returns the shared symmetricKey of the DKG that must be used to encrypt the symmetric encryption symmetricKey. This will be the same as LTS.X stored when creating Calypso.

Parameters:

ltsId - the long term secret ID

Returns:

the aggregate public symmetricKey of the ocs-shard

Throws:

CothorityCommunicationException - in case of communication difficulties

createLTS

public CreateLTSReply createLTS(Proof proof)
                         throws CothorityCommunicationException

Create a long-term-secret (LTS) and retrieve its configuration.

Returns:

The LTS configuration that is needed to execute the write contract.

Throws:

CothorityCommunicationException - if something went wrong

reshareLTS

public void reshareLTS(Proof proof)
                throws CothorityCommunicationException

Start a request to reshare the LTS. The new roster which holds the new secret shares must exist in the proof specified by the request. All hosts must be online in this step.

Parameters:

proof - the proof that contains the new roster, typically created using LTSInstance.

Throws:

CothorityCommunicationException - if something goes wrong

tryDecrypt

public DecryptKeyReply tryDecrypt(Proof writeProof,
                                  Proof readProof)
                           throws CothorityCommunicationException

Ask the secret-management cothority for the decryption shares.

Parameters:

writeProof - The proof of the write request.

readProof - The proof of the read request.

Returns:

All the decryption shares that can be used to reconstruct the decryption key.

Throws:

CothorityCommunicationException - if something went wrong

getLTSId

public LTSId getLTSId()

Returns:

the id of the Long Term Secret

getLTSX

public Point getLTSX()

Returns:

the shared public key of the Long Term Secret

getLTS

public CreateLTSReply getLTS()

Returns:

the Long Term Secret.

fromCalypso

public static CalypsoRPC fromCalypso(Roster roster,
                                     SkipblockId byzcoinId,
                                     LTSId ltsId)
                              throws CothorityException

Connects to an existing byzcoin and an existing Long Term Secret.

Parameters:

roster - the nodes handling the byzcoin ledger

byzcoinId - the id of the byzcoin ledger to connect to

ltsId - the id of the Long Term Secret to use

Returns:

CalypsoRPC if everything was found

Throws:

CothorityException - if something goes wrong

fromCalypso

public static CalypsoRPC fromCalypso(ByzCoinRPC bc,
                                     LTSId ltsId)
                              throws CothorityException

Connects to an existing Long Term Secret using a ByzCoinRPC.

Parameters:

bc - the ByzCoinRPC to use to talk to the ledger

ltsId - the id of the Long Term Secret to use

Returns:

CalypsoRPC if everything was found

Throws:

CothorityException - if something goes wrong

authorize

public static void authorize(ServerIdentity si,
                             SkipblockId byzcoinId)
                      throws CothorityCommunicationException

Connect to a server to an Authorized ByzCoin ID. This API is only works if the server is on the local network, unless the environment variable COTHORITY_ALLOW_INSECURE_ADMIN is set. As of 3.0.5, the authorization requires a signature by the private key of the conode. This is not implemented in java.

Parameters:

si - the server identity

byzcoinId - the ByzCoin ID

Throws:

CothorityCommunicationException - if something goes wrong.