-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
707 additions
and
8 deletions.
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 |
|---|---|---|
|
|
@@ -16,5 +16,7 @@ Cargo.lock | |
| debug | ||
| .wrangler | ||
| .dfx | ||
| .dfx_env | ||
|
|
||
| examples/**/.env | ||
| examples/**/.env | ||
| src/**/.env | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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,21 @@ | ||
| { | ||
| "canisters": { | ||
| "idempotent-proxy-canister": { | ||
| "candid": "src/idempotent-proxy-canister/idempotent-proxy-canister.did", | ||
| "declarations": { | ||
| "node_compatibility": true | ||
| }, | ||
| "package": "idempotent-proxy-canister", | ||
| "optimize": "cycles", | ||
| "type": "rust" | ||
| } | ||
| }, | ||
| "defaults": { | ||
| "build": { | ||
| "args": "", | ||
| "packtool": "" | ||
| } | ||
| }, | ||
| "output_env_file": ".dfx_env", | ||
| "version": 1 | ||
| } |
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,37 @@ | ||
| [package] | ||
| name = "idempotent-proxy-canister" | ||
| description = "idempotent-proxy canister" | ||
| repository = "https://github.com/ldclabs/idempotent-proxy/tree/main/src/idempotent-proxy-canister" | ||
| publish = false | ||
|
|
||
| version.workspace = true | ||
| edition.workspace = true | ||
| keywords.workspace = true | ||
| categories.workspace = true | ||
| license.workspace = true | ||
|
|
||
| # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | ||
|
|
||
| [lib] | ||
| crate-type = ["cdylib"] | ||
|
|
||
| [profile.release] | ||
| debug = false | ||
| lto = true | ||
| strip = true | ||
| opt-level = 's' | ||
|
|
||
| [dependencies] | ||
| async-trait = "0.1" | ||
| bytes = "1.6" | ||
| candid = "0.10" | ||
| ic-cdk = "0.14" | ||
| ic-cdk-timers = "0.8" | ||
| ic-stable-structures = "0.6" | ||
| url = "2.5" | ||
| base64 = { workspace = true } | ||
| ciborium = { workspace = true } | ||
| serde = { workspace = true } | ||
| serde_json = { workspace = true } | ||
| serde_bytes = { workspace = true } | ||
| sha3 = { workspace = true } |
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,39 @@ | ||
| # `idempotent-proxy-canister` | ||
|
|
||
| ## Running the project locally | ||
|
|
||
| If you want to test your project locally, you can use the following commands: | ||
|
|
||
| ```bash | ||
| # Starts the replica, running in the background | ||
| dfx start --background | ||
|
|
||
| # deploy the canister | ||
| dfx deploy idempotent-proxy-canister --argument "(opt variant {Init = | ||
| record { | ||
| ecdsa_key_name = \"dfx_test_key\"; | ||
| proxy_token_refresh_interval = 3600; | ||
| } | ||
| })" | ||
|
|
||
| dfx canister call idempotent-proxy-canister get_state '()' | ||
|
|
||
| dfx canister call idempotent-proxy-canister admin_set_agent ' | ||
| (vec { | ||
| record { | ||
| name = "LDCLabs"; | ||
| endpoint = "https://idempotent-proxy-cf-worker.zensh.workers.dev"; | ||
| max_cycles = 100000000000; | ||
| proxy_token = null; | ||
| } | ||
| }) | ||
| ' | ||
|
|
||
| ``` | ||
|
|
||
| `idempotent-proxy-cf-worker` does not enable `proxy-authorization`, so it can be accessed. | ||
|
|
||
| ## License | ||
| Copyright © 2024 [LDC Labs](https://github.com/ldclabs). | ||
|
|
||
| `ldclabs/idempotent-proxy` is licensed under the MIT License. See [LICENSE](../../LICENSE-MIT) for the full license text. |
52 changes: 52 additions & 0 deletions
52
src/idempotent-proxy-canister/idempotent-proxy-canister.did
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,52 @@ | ||
| type Agent = record { | ||
| proxy_token : opt text; | ||
| endpoint : text; | ||
| name : text; | ||
| max_cycles : nat64; | ||
| }; | ||
| type CanisterHttpRequestArgument = record { | ||
| url : text; | ||
| method : HttpMethod; | ||
| max_response_bytes : opt nat64; | ||
| body : opt blob; | ||
| transform : opt TransformContext; | ||
| headers : vec HttpHeader; | ||
| }; | ||
| type ChainArgs = variant { Upgrade : UpgradeArgs; Init : InitArgs }; | ||
| type HttpHeader = record { value : text; name : text }; | ||
| type HttpMethod = variant { get; head; post }; | ||
| type HttpResponse = record { | ||
| status : nat; | ||
| body : blob; | ||
| headers : vec HttpHeader; | ||
| }; | ||
| type InitArgs = record { | ||
| ecdsa_key_name : text; | ||
| proxy_token_refresh_interval : nat64; | ||
| }; | ||
| type Result = variant { Ok : bool; Err : text }; | ||
| type Result_1 = variant { Ok; Err : text }; | ||
| type Result_2 = variant { Ok : State; Err }; | ||
| type State = record { | ||
| proxy_token_public_key : text; | ||
| ecdsa_key_name : text; | ||
| managers : vec principal; | ||
| agents : vec Agent; | ||
| allowed_canisters : vec principal; | ||
| proxy_token_refresh_interval : nat64; | ||
| }; | ||
| type TransformArgs = record { context : blob; response : HttpResponse }; | ||
| type TransformContext = record { | ||
| function : func (TransformArgs) -> (HttpResponse) query; | ||
| context : blob; | ||
| }; | ||
| type UpgradeArgs = record { proxy_token_refresh_interval : opt nat64 }; | ||
| service : (opt ChainArgs) -> { | ||
| admin_add_canister : (principal) -> (Result); | ||
| admin_remove_canister : (principal) -> (Result); | ||
| admin_set_agent : (vec Agent) -> (Result_1); | ||
| admin_set_managers : (vec principal) -> (Result_1); | ||
| get_state : () -> (Result_2) query; | ||
| proxy_http_request : (CanisterHttpRequestArgument) -> (HttpResponse); | ||
| validate_admin_set_managers : (vec principal) -> (Result_1) query; | ||
| } |
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,89 @@ | ||
| use candid::{CandidType, Nat}; | ||
| use ic_cdk::api::management_canister::http_request::{ | ||
| http_request, CanisterHttpRequestArgument, HttpHeader, HttpResponse, TransformArgs, | ||
| TransformContext, | ||
| }; | ||
| use serde::{Deserialize, Serialize}; | ||
| use url::Url; | ||
|
|
||
| #[derive(CandidType, Default, Clone, Deserialize, Serialize)] | ||
| pub struct Agent { | ||
| pub name: String, // used as a prefix for idempotency_key and message in sign_proxy_token to separate different business processes. | ||
| pub endpoint: String, | ||
| pub max_cycles: u64, | ||
| pub proxy_token: Option<String>, | ||
| } | ||
|
|
||
| impl Agent { | ||
| fn build_request(&self, req: &mut CanisterHttpRequestArgument) -> Result<(), String> { | ||
| if !req.headers.iter().any(|h| h.name == "idempotency-key") { | ||
| Err("idempotency-key header is missing".to_string())?; | ||
| } | ||
|
|
||
| if req.url.starts_with("URL_") { | ||
| req.url = format!("{}/{}", self.endpoint, req.url); | ||
| } else { | ||
| let url = Url::parse(&req.url) | ||
| .map_err(|err| format!("parse url {} error: {}", req.url, err))?; | ||
| let host = url | ||
| .host_str() | ||
| .ok_or_else(|| format!("url host is empty: {}", req.url))?; | ||
| req.headers.push(HttpHeader { | ||
| name: "x-forwarded-host".to_string(), | ||
| value: host.to_string(), | ||
| }); | ||
| req.url.clone_from(&self.endpoint); | ||
| } | ||
|
|
||
| if !req.headers.iter().any(|h| h.name == "response-headers") { | ||
| req.headers.push(HttpHeader { | ||
| name: "response-headers".to_string(), | ||
| value: "date".to_string(), | ||
| }); | ||
| } | ||
|
|
||
| if let Some(proxy_token) = &self.proxy_token { | ||
| req.headers.push(HttpHeader { | ||
| name: "proxy-authorization".to_string(), | ||
| value: format!("Bearer {}", proxy_token), | ||
| }); | ||
| } | ||
|
|
||
| req.transform = Some(TransformContext::from_name( | ||
| "inner_transform_response".to_string(), | ||
| vec![], | ||
| )); | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| pub async fn call(&self, mut req: CanisterHttpRequestArgument) -> HttpResponse { | ||
| if let Err(err) = self.build_request(&mut req) { | ||
| return HttpResponse { | ||
| status: Nat::from(400u64), | ||
| body: err.into_bytes(), | ||
| headers: vec![], | ||
| }; | ||
| } | ||
|
|
||
| match http_request(req, self.max_cycles as u128).await { | ||
| Ok((res,)) => res, | ||
| Err((code, message)) => HttpResponse { | ||
| status: Nat::from(503u64), | ||
| body: format!("http_request resulted into error. code: {code:?}, error: {message}") | ||
| .into_bytes(), | ||
| headers: vec![], | ||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[ic_cdk::query(hidden = true)] | ||
| fn inner_transform_response(args: TransformArgs) -> HttpResponse { | ||
| HttpResponse { | ||
| status: args.response.status, | ||
| body: args.response.body, | ||
| // Remove headers (which may contain a timestamp) for consensus | ||
| headers: vec![], | ||
| } | ||
| } |
Oops, something went wrong.