-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
WIP feat: Add OidcValidator #274
Draft
matias-gonz
wants to merge
4
commits into
feat/oidc-account-recovery
Choose a base branch
from
matias/oidc-validator
base: feat/oidc-account-recovery
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// SPDX-License-Identifier: GPL-3.0 | ||
pragma solidity ^0.8.24; | ||
|
||
import { Transaction } from "@matterlabs/zksync-contracts/l2/system-contracts/libraries/TransactionHelper.sol"; | ||
import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol"; | ||
|
||
import { IModuleValidator } from "../interfaces/IModuleValidator.sol"; | ||
import { IModule } from "../interfaces/IModule.sol"; | ||
import { VerifierCaller } from "../helpers/VerifierCaller.sol"; | ||
|
||
/// @title OidcValidator | ||
/// @author Matter Labs | ||
/// @custom:security-contact [email protected] | ||
/// @dev This contract allows secure user authentication using OIDC protocol. | ||
contract OidcValidator is VerifierCaller, IModuleValidator { | ||
event OidcKeyUpdated(address indexed account, bytes iss, bool isNew); | ||
|
||
struct OidcData { | ||
bytes oidcDigest; // PoseidonHash(sub || aud || iss || salt) | ||
bytes iss; // Issuer | ||
bytes aud; // Audience | ||
} | ||
|
||
struct OidcSignature { | ||
bytes zkProof; | ||
bytes kid; // Key id used in the jwt | ||
} | ||
|
||
mapping(address => OidcData) public accountData; | ||
|
||
/// @notice Runs on module install | ||
/// @param data ABI-encoded OidcData key to add immediately, or empty if not needed | ||
function onInstall(bytes calldata data) external override { | ||
if (data.length > 0) { | ||
require(addValidationKey(data), "OidcValidator: key already exists"); | ||
} | ||
} | ||
|
||
/// @notice Runs on module uninstall | ||
/// @param data unused | ||
function onUninstall(bytes calldata data) external override { | ||
accountData[msg.sender] = OidcData(bytes(""), bytes(""), bytes("")); | ||
} | ||
|
||
/// @notice Adds an `OidcData` for the caller. | ||
/// @param key ABI-encoded `OidcData`. | ||
/// @return true if the key was added, false if it was updated. | ||
function addValidationKey(bytes calldata key) public returns (bool) { | ||
OidcData memory oidcData = abi.decode(key, (OidcData)); | ||
|
||
bool isNew = accountData[msg.sender].oidcDigest.length == 0; | ||
accountData[msg.sender] = oidcData; | ||
|
||
emit OidcKeyUpdated(msg.sender, oidcData.iss, isNew); | ||
return isNew; | ||
} | ||
|
||
/// @notice Validates a transaction to add a new passkey for the user. | ||
/// @dev Ensures the transaction calls `addValidationKey` in `WebAuthValidator` and verifies the zk proof. | ||
/// - Queries `OidcKeyRegistry` for the provider's public key (`pkop`). | ||
/// - Calls the verifier contract to validate the zk proof. | ||
/// - If the proof is valid, the transaction is approved, allowing `WebAuthValidator` to add the passkey. | ||
/// @param signedHash The hash of the transaction data that was signed. | ||
/// @param signature The signature to be verified, interpreted as an `OidcSignature`. | ||
/// @param transaction The transaction data being validated. | ||
/// @return true if the transaction is valid and authorized, false otherwise. | ||
function validateTransaction( | ||
bytes32 signedHash, | ||
bytes calldata signature, | ||
Transaction calldata transaction | ||
) external view returns (bool){ | ||
revert("OidcValidator: validateTransaction not implemented"); | ||
} | ||
|
||
/// @notice Unimplemented because signature validation is not required. | ||
/// @dev We only need `validateTransaction` to add new passkeys, so this function is intentionally left unimplemented. | ||
function validateSignature(bytes32 signedHash, bytes memory signature) external view returns (bool) { | ||
revert("OidcValidator: validateSignature not implemented"); | ||
} | ||
|
||
/// @inheritdoc IERC165 | ||
function supportsInterface(bytes4 interfaceId) public pure override returns (bool) { | ||
return | ||
interfaceId == type(IERC165).interfaceId || | ||
interfaceId == type(IModuleValidator).interfaceId || | ||
interfaceId == type(IModule).interfaceId; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding tests while you write this code. I believe that it's going to make you advance stronger :)