mirror of
https://github.com/zkemail/zk-email-verify.git
synced 2026-01-09 13:38:03 -05:00
circuits: improve helpers docs
This commit is contained in:
Saleel
@@ -58,7 +58,7 @@ They are used in `EmailVerifier` circuit for signature verification, but can als
|
||||
RSAVerifier65537: Verifies RSA signatures with exponent 65537.
|
||||
</summary>
|
||||
|
||||
- **[Source](https://github.com/zkemail/zk-email-verify/blob/v4/packages/circuits/lib/rsa.circom#L13-L39)**
|
||||
- **[Source](lib/rsa.circom#L13-L39)**
|
||||
- **Parameters**
|
||||
- `n`: Number of bits per chunk the modulus is split into. Recommended to be 121.
|
||||
- `k`: Number of chunks the modulus is split into. Recommended to be 17.
|
||||
@@ -69,29 +69,82 @@ RSAVerifier65537: Verifies RSA signatures with exponent 65537.
|
||||
|
||||
</details>
|
||||
|
||||
### sha.circom
|
||||
|
||||
### `@zk-email/circuits/lib/sha.circom`
|
||||
|
||||
<details>
|
||||
<summary>Sha256Bytes
|
||||
<summary>
|
||||
Sha256Bytes: Computes the SHA256 hash of input bytes.
|
||||
</summary>
|
||||
|
||||
**[`Sha256Bytes`](https://github.com/zkemail/zk-email-verify/blob/v4/packages/circuits/lib/sha.circom#L17-L38 "SHA Hashing")**: Utilized for SHA-256 hashing of byte arrays. This is suitable for processing various types of data, such as email headers and bodies, within the constraints of the circuit.
|
||||
- **[Source](lib/sha.circom#L17-L38)**
|
||||
- **Parameters**
|
||||
- `maxByteLength`: Maximum length of the input bytes.
|
||||
- **Inputs**:
|
||||
- `in_padded`: The byte array to be hashed, padded according to SHA-256 requirements.
|
||||
- `in_len_padded_bytes`: The byte length of the padded input.
|
||||
- `paddedIn[maxByteLength]`: Message to hash padded as per the SHA256 specification.
|
||||
- `paddedInLength`: Length of the message in bytes including padding.
|
||||
- **Output**:
|
||||
- A 256-bit array representing the SHA-256 hash of the input.
|
||||
- **Usage**:
|
||||
- To hash data using `Sha256Bytes`, include this template in your circuit and provide the necessary inputs to receive the SHA-256 hash output.
|
||||
- `out[256]`: The 256-bit hash of the input message.
|
||||
|
||||
**[`Sha256BytesPartial`](https://github.com/zkemail/zk-email-verify/blob/v4/packages/circuits/lib/sha.circom#L47-L79 "SHA Partial Hashing")**: Facilitates SHA-256 hashing with an optimization for known partial pre-hash states.
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Sha256BytesPartial: Computes the SHA256 hash of input bytes with a precomputed state.
|
||||
</summary>
|
||||
|
||||
- **[Source](lib/sha.circom#L41-L79)**
|
||||
- **Parameters**
|
||||
- `maxByteLength`: Maximum length of the input bytes.
|
||||
- **Inputs**:
|
||||
- `in_padded`: The byte array for hashing, with appropriate padding.
|
||||
- `in_len_padded_bytes`: The byte length of the padded input.
|
||||
- `pre_hash`: A 32-byte array representing the partial pre-hash state.
|
||||
- `paddedIn[maxByteLength]`: Message to hash padded as per the SHA256 specification.
|
||||
- `paddedInLength`: Length of the message in bytes including padding.
|
||||
- `preHash[32]`: The precomputed state of the hash.
|
||||
- **Output**:
|
||||
- A 256-bit array representing the SHA-256 hash of the input, taking into account the pre-hash state.
|
||||
- **Usage**:
|
||||
- For optimized SHA-256 hashing with a known pre-hash state, use `Sha256BytesPartial` by specifying the inputs, including the pre-hash state.
|
||||
- `out[256]`: The 256-bit hash of the input message.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Sha256General: A modified version of the SHA256 circuit that allows specified length messages up to a max to all work via array indexing on the SHA256 compression circuit.
|
||||
</summary>
|
||||
|
||||
- **[Source](lib/sha.circom#L82-L202)**
|
||||
- **Parameters**
|
||||
- `maxBitLength`: Maximum length of the input bits.
|
||||
- **Inputs**:
|
||||
- `paddedIn[maxBitLength]`: Message to hash padded as per the SHA256 specification.
|
||||
- `paddedInLength`: Length of the message in bits including padding.
|
||||
- **Output**:
|
||||
- `out[256]`: The 256-bit hash of the input message.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Sha256Partial: Calculates the SHA256 hash of a message with a precomputed state.
|
||||
</summary>
|
||||
|
||||
- **[Source](lib/sha.circom#L211-L299)**
|
||||
- **Parameters**
|
||||
- `maxBitLength`: Maximum length of the input bits.
|
||||
- **Inputs**:
|
||||
- `paddedIn[maxBitLength]`: Message to hash padded as per the SHA256 specification.
|
||||
- `paddedInLength`: Length of the message in bits including padding.
|
||||
- `preHash[256]`: The precomputed state of the hash.
|
||||
- **Output**:
|
||||
- `out[256]`: The 256-bit hash of the input message.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
### base64.circom
|
||||
This component decodes base64 encoded data within arithmetic circuits, focusing on the conversion of base64 encoded strings into binary data.
|
||||
|
||||
@@ -20,14 +20,14 @@ include "./utils/hash.circom";
|
||||
/// @param n Number of bits per chunk the RSA key is split into. Recommended to be 121.
|
||||
/// @param k Number of chunks the RSA key is split into. Recommended to be 17.
|
||||
/// @param ignoreBodyHashCheck Set 1 to skip body hash check in case data to prove/extract is only in the headers.
|
||||
/// @input emailHeader Email headers that are signed (ones in `DKIM-Signature` header) as ASCII int[], padded as per SHA-256 block size.
|
||||
/// @input emailHeader[maxHeadersLength] Email headers that are signed (ones in `DKIM-Signature` header) as ASCII int[], padded as per SHA-256 block size.
|
||||
/// @input emailHeaderLength Length of the email header including the SHA-256 padding.
|
||||
/// @input pubkey RSA public key split into k chunks of n bits each.
|
||||
/// @input signature RSA signature split into k chunks of n bits each.
|
||||
/// @input emailBody Email body after the precomputed SHA as ASCII int[], padded as per SHA-256 block size.
|
||||
/// @input pubkey[k] RSA public key split into k chunks of n bits each.
|
||||
/// @input signature[k] RSA signature split into k chunks of n bits each.
|
||||
/// @input emailBody[maxBodyLength] Email body after the precomputed SHA as ASCII int[], padded as per SHA-256 block size.
|
||||
/// @input emailBodyLength Length of the email body including the SHA-256 padding.
|
||||
/// @input bodyHashIndex Index of the body hash `bh` in the emailHeader.
|
||||
/// @input precomputedSHA Precomputed SHA-256 hash of the email body till the bodyHashIndex.
|
||||
/// @input precomputedSHA[32] Precomputed SHA-256 hash of the email body till the bodyHashIndex.
|
||||
/// @output pubkeyHash Poseidon hash of the pubkey - Poseidon(n/2)(n/2 chunks of pubkey with k*2 bits per chunk).
|
||||
template EmailVerifier(maxHeadersLength, maxBodyLength, n, k, ignoreBodyHashCheck) {
|
||||
assert(maxHeadersLength % 64 == 0);
|
||||
|
||||
@@ -8,8 +8,8 @@ include "./fp.circom";
|
||||
/// @param n Number of bits per chunk the modulus is split into. Recommended to be 121.
|
||||
/// @param k Number of chunks the modulus is split into. Recommended to be 17.
|
||||
/// @input message The message that was signed.
|
||||
/// @input signature The signature to verify.
|
||||
/// @input modulus The modulus of the RSA key (pubkey).
|
||||
/// @input signature[k] The signature to verify.
|
||||
/// @input modulus[k] The modulus of the RSA key (pubkey).
|
||||
template RSAVerifier65537(n, k) {
|
||||
signal input message[k];
|
||||
signal input signature[k];
|
||||
|
||||
Reference in New Issue
Block a user