api

type AuthRequest struct {
	// / User email
	Email string `protobuf:"bytes,1,opt,name=email" json:"email,omitempty"`
	// / User authentication token
	Token string `protobuf:"bytes,2,opt,name=token" json:"token,omitempty"`
}

type Contract struct {
	// / The result code
	ErrorCode *ErrorCode `protobuf:"bytes,1,opt,name=errorCode" json:"errorCode,omitempty"`
	// / The JSON object of the contract, equivalent to the one that was sent by mail to signers
	Json []byte `protobuf:"bytes,2,opt,name=json,proto3" json:"json,omitempty"`
}

type Empty struct {
}

type ErrorCode struct {
	Code ErrorCode_Code `protobuf:"varint,1,opt,name=code,enum=api.ErrorCode_Code" json:"code,omitempty"`
	// / An additional message, if needed
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
}

type ErrorCode_Code int32

type GetContractRequest struct {
	// / UUID of the requested contract
	Uuid string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
}

type JoinSignatureRequest struct {
	// / The contract UUID to join
	ContractUuid string `protobuf:"bytes,1,opt,name=contractUuid" json:"contractUuid,omitempty"`
	// / The open port for P2P communication of the client
	Port uint32 `protobuf:"varint,2,opt,name=port" json:"port,omitempty"`
	// / The offered ips for P2P communication of the client
	Ip []string `protobuf:"bytes,3,rep,name=ip" json:"ip,omitempty"`
}

type LaunchSignature struct {
	// / The result code
	ErrorCode *ErrorCode `protobuf:"bytes,1,opt,name=errorCode" json:"errorCode,omitempty"`
	// / The unique signature generated by the platform for this specific signature attempt
	SignatureUuid string `protobuf:"bytes,2,opt,name=signatureUuid" json:"signatureUuid,omitempty"`
	// / The SHA-512 hash of the contract document
	DocumentHash []byte `protobuf:"bytes,3,opt,name=documentHash,proto3" json:"documentHash,omitempty"`
	// / A confirmation of client hashes for communication authentication
	KeyHash [][]byte `protobuf:"bytes,4,rep,name=keyHash,proto3" json:"keyHash,omitempty"`
	// / The signing sequence generated on-the-fly by the platform
	Sequence []uint32 `protobuf:"varint,5,rep,name=sequence" json:"sequence,omitempty"`
	// / The ttp can be nil if no ttp is available for this signature
	Ttp *LaunchSignature_TTP `protobuf:"bytes,6,opt,name=ttp" json:"ttp,omitempty"`
	// / The cryptographic object of the signature of this structure (seal and errorCode excepted) by the platform, for data certification.
	// / The signature is computed using auth.SignStructure function:
	// / PKCS1v15 + SHA512 hash of the string representation of the structure
	Seal []byte `protobuf:"bytes,10,opt,name=seal,proto3" json:"seal,omitempty"`
}

type LaunchSignature_TTP struct {
	Addrport string `protobuf:"bytes,1,opt,name=addrport" json:"addrport,omitempty"`
	Hash     []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"`
}

type PlatformClient interface {
	// / Register a new user, no authentication required.
	Register(ctx context.Context, in *RegisterRequest, opts ...grpc.CallOption) (*ErrorCode, error)
	// / Authenticate a previously registered user, no authentication required.
	Auth(ctx context.Context, in *AuthRequest, opts ...grpc.CallOption) (*RegisteredUser, error)
	// / Unregister a new user, authentication required.
	Unregister(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*ErrorCode, error)
	// / Create a new contract, authentication required.
	PostContract(ctx context.Context, in *PostContractRequest, opts ...grpc.CallOption) (*ErrorCode, error)
	// / Fetch a previously create contract, authentication required.
	GetContract(ctx context.Context, in *GetContractRequest, opts ...grpc.CallOption) (*Contract, error)
	// / Join a signature discovery room, authentication required.
	// The stream is triggered for each new user connected in this channel.
	JoinSignature(ctx context.Context, in *JoinSignatureRequest, opts ...grpc.CallOption) (Platform_JoinSignatureClient, error)
	// / Join an ignition room, authentication required.
	// The response is returned when every signer is ready for a specific contract.
	// Warning, can me answered with a very high delay.
	ReadySign(ctx context.Context, in *ReadySignRequest, opts ...grpc.CallOption) (*LaunchSignature, error)
}

type PlatformServer interface {
	// / Register a new user, no authentication required.
	Register(context.Context, *RegisterRequest) (*ErrorCode, error)
	// / Authenticate a previously registered user, no authentication required.
	Auth(context.Context, *AuthRequest) (*RegisteredUser, error)
	// / Unregister a new user, authentication required.
	Unregister(context.Context, *Empty) (*ErrorCode, error)
	// / Create a new contract, authentication required.
	PostContract(context.Context, *PostContractRequest) (*ErrorCode, error)
	// / Fetch a previously create contract, authentication required.
	GetContract(context.Context, *GetContractRequest) (*Contract, error)
	// / Join a signature discovery room, authentication required.
	// The stream is triggered for each new user connected in this channel.
	JoinSignature(*JoinSignatureRequest, Platform_JoinSignatureServer) error
	// / Join an ignition room, authentication required.
	// The response is returned when every signer is ready for a specific contract.
	// Warning, can me answered with a very high delay.
	ReadySign(context.Context, *ReadySignRequest) (*LaunchSignature, error)
}

type Platform_JoinSignatureClient interface {
	Recv() (*UserConnected, error)
	grpc.ClientStream
}

type Platform_JoinSignatureServer interface {
	Send(*UserConnected) error
	grpc.ServerStream
}

type PostContractRequest struct {
	// / Contract SHA-512 hash
	Hash []byte `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// / Contract filename
	Filename string `protobuf:"bytes,2,opt,name=filename" json:"filename,omitempty"`
	// / List of signers emails
	Signer []string `protobuf:"bytes,3,rep,name=signer" json:"signer,omitempty"`
	// / Additional comment
	Comment string `protobuf:"bytes,4,opt,name=comment" json:"comment,omitempty"`
}

type ReadySignRequest struct {
	// / The contract UUID to be ready for
	ContractUuid string `protobuf:"bytes,1,opt,name=contractUuid" json:"contractUuid,omitempty"`
}

type RegisterRequest struct {
	// / User mail
	Email string `protobuf:"bytes,1,opt,name=email" json:"email,omitempty"`
	// / Certificate request (CSR) as PEM
	Request string `protobuf:"bytes,2,opt,name=request" json:"request,omitempty"`
}

type RegisteredUser struct {
	// / User certificate, as generated by the platform (PEM)
	ClientCert string `protobuf:"bytes,1,opt,name=clientCert" json:"clientCert,omitempty"`
}

type User struct {
	// / The certificate hash of the user
	KeyHash []byte `protobuf:"bytes,1,opt,name=keyHash,proto3" json:"keyHash,omitempty"`
	Email   string `protobuf:"bytes,2,opt,name=email" json:"email,omitempty"`
	// / The IP offered by the user for P2P
	Ip []string `protobuf:"bytes,3,rep,name=ip" json:"ip,omitempty"`
	// / The port offered by the user for P2P
	Port uint32 `protobuf:"varint,4,opt,name=port" json:"port,omitempty"`
}

type UserConnected struct {
	// / The result code.
	// Very bad if not equals to SUCCESS, in this case the client should close the connection
	ErrorCode *ErrorCode `protobuf:"bytes,1,opt,name=errorCode" json:"errorCode,omitempty"`
	// / A confirmation about the contract UUID
	ContractUuid string `protobuf:"bytes,2,opt,name=contractUuid" json:"contractUuid,omitempty"`
	// / One user connecting to this contract's room
	User *User `protobuf:"bytes,3,opt,name=user" json:"user,omitempty"`
}