crypto

README

This package contains logic which implements the cryptographic requirements of TEN.

1. Manage the shared secret of the network.(SS) - shared_secret_service
2. Manage the "Ten RPC" encryption - which is the key used by all clients to communicate with the TEN network (key derived from SS) - rpc_key_service
3. Manage the Data availability(DA) (Rollup and Batches) Encryption/Decryption ( key derived from SS). - da_enc_service
4. Manage the enclave key signature/encryption/decryption/ id derivation. - enclave_key_service
5. Manage entropy per batch and tx - evm_entropy_service

Documentation

Index

• Constants
• type DAEncryptionService
  • func NewDAEncryptionService(sharedSecretService *SharedSecretService, logger gethlog.Logger) *DAEncryptionService
  • func (t *DAEncryptionService) Decrypt(blob []byte) ([]byte, error)
  • func (t *DAEncryptionService) Encrypt(blob []byte) ([]byte, error)
  • func (t *DAEncryptionService) Initialise() error
• type EnclaveAttestedKeyService
  • func NewEnclaveAttestedKeyService(logger gethlog.Logger) *EnclaveAttestedKeyService
  • func (eks *EnclaveAttestedKeyService) Decrypt(encBytes []byte) ([]byte, error)
  • func (eks *EnclaveAttestedKeyService) EnclaveID() common.EnclaveID
  • func (eks *EnclaveAttestedKeyService) Encrypt(encBytes []byte) ([]byte, error)
  • func (eks *EnclaveAttestedKeyService) GenerateEnclaveKey() ([]byte, error)
  • func (eks *EnclaveAttestedKeyService) PublicKey() *ecdsa.PublicKey
  • func (eks *EnclaveAttestedKeyService) PublicKeyBytes() []byte
  • func (eks *EnclaveAttestedKeyService) SetEnclaveKey(keyBytes []byte)
  • func (eks *EnclaveAttestedKeyService) Sign(payload gethcommon.Hash) ([]byte, error)
• type EvmEntropyService
  • func NewEvmEntropyService(sc *SharedSecretService, logger gethlog.Logger) *EvmEntropyService
  • func (ees *EvmEntropyService) BatchEntropy(batch *common.BatchHeader) gethcommon.Hash
  • func (ees *EvmEntropyService) TxEntropy(rootBatchEntropy []byte, tCount int) gethcommon.Hash
• type RPCKeyService
  • func NewRPCKeyService(sharedSecretService *SharedSecretService, logger gethlog.Logger) *RPCKeyService
  • func (s *RPCKeyService) DecryptRPCRequest(bytes []byte) ([]byte, error)
  • func (s *RPCKeyService) Initialise() error
  • func (s *RPCKeyService) PublicKey() ([]byte, error)
• type SharedEnclaveSecret
• type SharedSecretService
  • func NewSharedSecretService(logger gethlog.Logger) *SharedSecretService
  • func (sss *SharedSecretService) EncryptSecretWithKey(pubKey []byte) (common.EncryptedSharedEnclaveSecret, error)
  • func (sss *SharedSecretService) ExtendEntropy(extra []byte) []byte
  • func (sss *SharedSecretService) GenerateSharedSecret()
  • func (sss *SharedSecretService) IsGenesis() bool
  • func (sss *SharedSecretService) IsInitialised() bool
  • func (sss *SharedSecretService) Secret() *SharedEnclaveSecret
  • func (sss *SharedSecretService) SetSharedSecret(ss *SharedEnclaveSecret)

Constants

const (
	// GCMNonceLength is the nonce's length in bytes for encrypting and decrypting transactions.
	GCMNonceLength = 12
)

Types

type DAEncryptionService

type DAEncryptionService struct {
	// contains filtered or unexported fields
}

DAEncryptionService - handles encryption/decryption of the data stored in the DA layer

func NewDAEncryptionService

func NewDAEncryptionService(sharedSecretService *SharedSecretService, logger gethlog.Logger) *DAEncryptionService

func (*DAEncryptionService) Decrypt

func (t *DAEncryptionService) Decrypt(blob []byte) ([]byte, error)

func (*DAEncryptionService) Encrypt

func (t *DAEncryptionService) Encrypt(blob []byte) ([]byte, error)

func (*DAEncryptionService) Initialise

func (t *DAEncryptionService) Initialise() error

type EnclaveAttestedKeyService

type EnclaveAttestedKeyService struct {
	// contains filtered or unexported fields
}

EnclaveAttestedKeyService manages the attestation key - including

func NewEnclaveAttestedKeyService

func NewEnclaveAttestedKeyService(logger gethlog.Logger) *EnclaveAttestedKeyService

func (*EnclaveAttestedKeyService) Decrypt

func (eks *EnclaveAttestedKeyService) Decrypt(encBytes []byte) ([]byte, error)

func (*EnclaveAttestedKeyService) EnclaveID

func (eks *EnclaveAttestedKeyService) EnclaveID() common.EnclaveID

func (*EnclaveAttestedKeyService) Encrypt

func (eks *EnclaveAttestedKeyService) Encrypt(encBytes []byte) ([]byte, error)

func (*EnclaveAttestedKeyService) GenerateEnclaveKey

func (eks *EnclaveAttestedKeyService) GenerateEnclaveKey() ([]byte, error)

func (*EnclaveAttestedKeyService) PublicKey

func (eks *EnclaveAttestedKeyService) PublicKey() *ecdsa.PublicKey

func (*EnclaveAttestedKeyService) PublicKeyBytes

func (eks *EnclaveAttestedKeyService) PublicKeyBytes() []byte

func (*EnclaveAttestedKeyService) SetEnclaveKey

func (eks *EnclaveAttestedKeyService) SetEnclaveKey(keyBytes []byte)

func (*EnclaveAttestedKeyService) Sign

func (eks *EnclaveAttestedKeyService) Sign(payload gethcommon.Hash) ([]byte, error)

type EvmEntropyService

type EvmEntropyService struct {
	// contains filtered or unexported fields
}

EvmEntropyService - generates the entropy that is injected into the EVM - unique for each transaction

func NewEvmEntropyService

func NewEvmEntropyService(sc *SharedSecretService, logger gethlog.Logger) *EvmEntropyService

func (*EvmEntropyService) BatchEntropy

func (ees *EvmEntropyService) BatchEntropy(batch *common.BatchHeader) gethcommon.Hash

BatchEntropy - calculates entropy per batch In Ten, we use a root entropy per batch, which is then used to calculate randomness exposed to individual transactions The RootBatchEntropy is calculated based on the shared secret, the batch height and the timestamp This ensures that sibling batches will naturally use the same root entropy so that transactions will have the same results

func (*EvmEntropyService) TxEntropy

func (ees *EvmEntropyService) TxEntropy(rootBatchEntropy []byte, tCount int) gethcommon.Hash

TxEntropy - calculates the randomness exposed to individual transactions In TEN, each tx has its own independent randomness, because otherwise a malicious transaction from the same batch could reveal information.

type RPCKeyService

type RPCKeyService struct {
	// contains filtered or unexported fields
}

RPCKeyService - manages the "TEN - RPC key" used by clients (like the TEN gateway) to make RPC requests

func NewRPCKeyService

func NewRPCKeyService(sharedSecretService *SharedSecretService, logger gethlog.Logger) *RPCKeyService

func (*RPCKeyService) DecryptRPCRequest

func (s *RPCKeyService) DecryptRPCRequest(bytes []byte) ([]byte, error)

func (*RPCKeyService) Initialise

func (s *RPCKeyService) Initialise() error

Initialise - called when the shared secret is available

func (*RPCKeyService) PublicKey

func (s *RPCKeyService) PublicKey() ([]byte, error)

type SharedEnclaveSecret

type SharedEnclaveSecret [sharedSecretLenInBytes]byte

SharedEnclaveSecret - the entropy

type SharedSecretService

type SharedSecretService struct {
	// contains filtered or unexported fields
}

SharedSecretService provides functionality to encapsulate, generate, extend, and encrypt the shared secret of the TEN network.

func NewSharedSecretService

func NewSharedSecretService(logger gethlog.Logger) *SharedSecretService

func (*SharedSecretService) EncryptSecretWithKey

func (sss *SharedSecretService) EncryptSecretWithKey(pubKey []byte) (common.EncryptedSharedEnclaveSecret, error)

func (*SharedSecretService) ExtendEntropy

func (sss *SharedSecretService) ExtendEntropy(extra []byte) []byte

ExtendEntropy derives more entropy from the shared secret

func (*SharedSecretService) GenerateSharedSecret

func (sss *SharedSecretService) GenerateSharedSecret()

GenerateSharedSecret - called only by the genesis

func (*SharedSecretService) IsGenesis

func (sss *SharedSecretService) IsGenesis() bool

func (*SharedSecretService) IsInitialised

func (sss *SharedSecretService) IsInitialised() bool

func (*SharedSecretService) Secret

func (sss *SharedSecretService) Secret() *SharedEnclaveSecret

Secret - should only be used before storing it

func (*SharedSecretService) SetSharedSecret

func (sss *SharedSecretService) SetSharedSecret(ss *SharedEnclaveSecret)