Skip to content

Smiller coti/ct address #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Smiller coti/ct address #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c0463c
update string encryption/decryption
spencer-xyz Aug 18, 2024
9126ab9
remove function selector computation logic
spencer-xyz Aug 18, 2024
5a24b5d
update uint encryption
spencer-xyz Sep 29, 2024
ba8c644
add support for ctAddress
spencer-xyz Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 67 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,14 +199,14 @@ signature = sign(message, key)

- `signature`: The generated signature.

### 7. `build_input_text(plaintext, user_aes_key, sender, contract, func_sig, signing_key)`
### 7. `build_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)`

**Purpose:** Builds input text by encrypting the plaintext and signing it.

**Usage:**

```python
int_cipher_text, signature = build_input_text(plaintext, user_aes_key, sender, contract, func_sig, signing_key)
int_cipher_text, signature = build_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)
```

**Parameters:**
Expand All @@ -215,102 +215,112 @@ int_cipher_text, signature = build_input_text(plaintext, user_aes_key, sender, c
- `user_aes_key`: The user's AES key.
- `sender`: The sender's address.
- `contract`: The contract address.
- `func_sig`: The function signature.
- `func_selector`: The function selector.
- `signing_key`: The private key used for signing.

**Returns:**

- `int_cipher_text`: The integer representation of the ciphertext.
- `signature`: The generated signature.

### 8. `generate_rsa_keypair()`
### 8. `build_string_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)`

**Purpose:** Generates an RSA key pair.
**Purpose:** Builds input text by encrypting the plaintext and signing it.

**Usage:**

```python
private_key_bytes, public_key_bytes = generate_rsa_keypair()
int_cipher_text, signature = build_string_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)
```

**Parameters:**

- `plaintext`: The plaintext message.
- `user_aes_key`: The user's AES key.
- `sender`: The sender's address.
- `contract`: The contract address.
- `func_selector`: The function selector.
- `signing_key`: The private key used for signing.

**Returns:**

- `private_key_bytes`: The serialized private key.
- `public_key_bytes`: The serialized public key.
- `input_text`: A dictionary of the form { "ciphertext": { "value": int[] }, "signature": bytes[] }

### 9. `encrypt_rsa(public_key_bytes, plaintext)`
### 9. `build_address_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)`

**Purpose:** Encrypts plaintext using RSA encryption with a provided public key.
**Purpose:** Builds input text by encrypting the plaintext and signing it.

**Usage:**

```python
ciphertext = encrypt_rsa(public_key_bytes, plaintext)
int_cipher_text, signature = build_address_input_text(plaintext, user_aes_key, sender, contract, func_selector, signing_key)
```

**Parameters:**

- `public_key_bytes`: The serialized public key.
- `plaintext`: The plaintext message to be encrypted.
- `plaintext`: The plaintext message.
- `user_aes_key`: The user's AES key.
- `sender`: The sender's address.
- `contract`: The contract address.
- `func_selector`: The function selector.
- `signing_key`: The private key used for signing.

**Returns:**

- `ciphertext`: The encrypted message.
- `input_text`: A dictionary of the form { "ciphertext": { "ct1": int, "ct2": int, "ct3": int }, "signature1": bytes, "signature2": bytes, "signature3": bytes }

### 10. `decrypt_rsa(private_key_bytes, ciphertext)`
### 10. `generate_rsa_keypair()`

**Purpose:** Decrypts ciphertext using RSA decryption with a provided private key.
**Purpose:** Generates an RSA key pair.

**Usage:**

```python
plaintext = decrypt_rsa(private_key_bytes, ciphertext)
private_key_bytes, public_key_bytes = generate_rsa_keypair()
```

**Parameters:**

- `private_key_bytes`: The serialized private key.
- `ciphertext`: The encrypted message to be decrypted.

**Returns:**

- `plaintext`: The decrypted message.
- `private_key_bytes`: The serialized private key.
- `public_key_bytes`: The serialized public key.

### 11. `keccak256(data)`
### 11. `encrypt_rsa(public_key_bytes, plaintext)`

**Purpose:** Computes the Keccak-256 hash of the provided data.
**Purpose:** Encrypts plaintext using RSA encryption with a provided public key.

**Usage:**

```python
hash_value = keccak256(data)
ciphertext = encrypt_rsa(public_key_bytes, plaintext)
```

**Parameters:**

- `data`: The data to be hashed.
- `public_key_bytes`: The serialized public key.
- `plaintext`: The plaintext message to be encrypted.

**Returns:**

- `hash_value`: The computed hash.
- `ciphertext`: The encrypted message.

### 12. `get_func_sig(function_signature)`
### 12. `decrypt_rsa(private_key_bytes, ciphertext)`

**Purpose:** Computes the function signature hash using Keccak-256.
**Purpose:** Decrypts ciphertext using RSA decryption with a provided private key.

**Usage:**

```python
func_sig_hash = get_func_sig(function_signature)
plaintext = decrypt_rsa(private_key_bytes, ciphertext)
```

**Parameters:**

- `function_signature`: The function signature string.
- `private_key_bytes`: The serialized private key.
- `ciphertext`: The encrypted message to be decrypted.

**Returns:**

- `func_sig_hash`: The first 4 bytes of the computed hash.
- `plaintext`: The decrypted message.

### 13. `decrypt_uint(ciphertext, user_key)`

Expand Down Expand Up @@ -343,13 +353,32 @@ plaintext = decrypt_string(ciphertext, user_key)

**Parameters:**

- `ciphertext`: The value to be decrypted.
- `ciphertext`: A dictionary of the form { "value": int[] } where each cell holds up to 8 characters (padded at the end with zeroes) encrypted
- `userKey`: The user's AES key.

**Returns:**

- `result`: The decrypted value.

### 15. `decrypt_address(ciphertext, user_key)`

**Purpose:** Decrypts a value stored in a contract and encrypted using a user key

**Usage:**

```python
plaintext = decrypt_string(ciphertext, user_key)
```

**Parameters:**

- `ciphertext`: A dictionary of the form { "ct1": int, "ct2": int, "ct3": int } where each cell holds a portion of the address encrypted
- `userKey`: The user's AES key.

**Returns:**

- `result`: The decrypted address.

# Utilities (utils.py) Functions

### 1. `web3_connected(web3)`
Expand Down Expand Up @@ -620,25 +649,7 @@ valid, gas_estimate = is_gas_units_estimation_valid(web3, tx)
- `valid`: Boolean indicating if the gas units are sufficient.
- `gas_estimate`: The estimated gas units.

### 16. `get_function_signature(function_abi)`

**Purpose:** Generates the function signature from the ABI.

**Usage:**

```python
func_sig = get_function_signature(function_abi)
```

**Parameters:**

- `function_abi`: The ABI of the function.

**Returns:**

- `func_sig`: The function signature.

### 17. `deploy_contract(contract, kwargs, tx_params)`
### 16. `deploy_contract(contract, kwargs, tx_params)`

**Purpose:** Deploys a contract with the given parameters.

Expand All @@ -658,7 +669,7 @@ tx_receipt = deploy_contract(contract, kwargs, tx_params)

- `tx_receipt`: The transaction receipt.

### 18. `exec_func_via_transaction(func, tx_params)`
### 17. `exec_func_via_transaction(func, tx_params)`

**Purpose:** Executes a contract function via a transaction.

Expand All @@ -677,7 +688,7 @@ tx_receipt = exec_func_via_transaction(func, tx_params)

- `tx_receipt`: The transaction receipt.

### 19. `sign_and_send_tx(web3, private_key, transaction)`
### 18. `sign_and_send_tx(web3, private_key, transaction)`

**Purpose:** Signs and sends a transaction.

Expand All @@ -697,7 +708,7 @@ tx_receipt = sign_and_send_tx(web3, private_key, transaction)

- `tx_receipt`: The transaction receipt.

### 20. `decrypt_value(contract_value, user_key)`
### 19. `decrypt_value(contract_value, user_key)`

**Purpose:** Decrypts a value stored in a contract using a user key.

Expand Down
Loading