Skip to content
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

Jump to bottom

whitelist certain wasms #175

Merged
merged 11 commits into from
Jul 5, 2023
Merged

whitelist certain wasms #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fc9a377
whitelist certain wasms
sesi200 Jun 8, 2023
614c237
use backend to hash
sesi200 Jun 9, 2023
3fb6da8
new whitelist approach
sesi200 Jun 13, 2023
5753d67
cleanup
sesi200 Jun 13, 2023
6530356
add to whitelist
sesi200 Jun 13, 2023
3b41e18
fix
sesi200 Jun 13, 2023
775b6b5
fix
sesi200 Jun 13, 2023
143a25e
address code review
sesi200 Jun 23, 2023
cadfdc4
appease CI?
sesi200 Jun 29, 2023
bc91f9d
Merge branch 'main' into severin/wasm-whitelist
sesi200 Jun 30, 2023
84d4f93
next try
sesi200 Jun 30, 2023
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
14 changes: 10 additions & 4 deletions service/pool/Main.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ shared (creator) actor class Self(opt_params : ?Types.InitParams) = this {
await getExpiredCanisterInfo();
};

public func installCode(info : Types.CanisterInfo, args : Types.InstallArgs, profiling : Bool) : async Types.CanisterInfo {
public shared ({ caller }) func installCode(info : Types.CanisterInfo, args : Types.InstallArgs, profiling : Bool, is_whitelisted : Bool) : async Types.CanisterInfo {
if (info.timestamp == 0) {
stats := Logs.updateStats(stats, #mismatch);
throw Error.reject "Cannot install removed canister";
Expand All @@ -140,7 +140,13 @@ shared (creator) actor class Self(opt_params : ?Types.InitParams) = this {
limit_stable_memory_page = ?(16384 : Nat32); // Limit to 1G of stable memory
backend_canister_id = ?Principal.fromActor(this);
};
let wasm = await Wasm.transform(args.wasm_module, config);
let wasm = if (caller == controller and is_whitelisted) {
args.wasm_module;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to bypass the controller for testing? If so, we only want to bypass when is_whitelisted is true.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the bypass is required for testing. But restricting to is_whitelisted is fine

} else if (is_whitelisted) {
await Wasm.is_whitelisted(args.wasm_module);
} else {
await Wasm.transform(args.wasm_module, config);
};
let newArgs = {
arg = args.arg;
wasm_module = wasm;
Expand Down Expand Up @@ -313,7 +319,7 @@ shared (creator) actor class Self(opt_params : ?Types.InitParams) = this {
switch (sanitizeInputs(caller, canister_id)) {
case (#ok info) {
let args = { arg; wasm_module; mode; canister_id };
ignore await installCode(info, args, pool.profiling caller); // inherit the profiling of the parent
ignore await installCode(info, args, pool.profiling caller, false); // inherit the profiling of the parent
};
case (#err makeMsg) throw Error.reject(makeMsg "install_code");
};
Expand Down Expand Up @@ -378,7 +384,7 @@ shared (creator) actor class Self(opt_params : ?Types.InitParams) = this {
msg : {
#GCCanisters : Any;
#balance : Any;
#callForward: Any;
#callForward : Any;
#dump : Any;
#getCanisterId : Any;
#getSubtree : Any;
Expand Down
8 changes: 4 additions & 4 deletions service/pool/tests/actor_class/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ let S = install(wasm, null, opt 100_000_000_000_000);
let nonce = record { timestamp = 1 : int; nonce = 1 : nat };
let c1 = call S.getCanisterId(nonce);
let args = record { arg = blob ""; wasm_module = parent; mode = variant { install }; canister_id = c1.id };
call S.installCode(c1, args, false);
call S.installCode(c1, args, false, false);

let c1 = c1.id;

Expand Down Expand Up @@ -50,7 +50,7 @@ let S = install(wasm, init, opt 100_000_000_000_000);
let nonce = record { timestamp = 1 : int; nonce = 1 : nat };
let c1 = call S.getCanisterId(nonce);
let args = record { arg = blob ""; wasm_module = parent; mode = variant { install }; canister_id = c1.id };
call S.installCode(c1, args, false);
call S.installCode(c1, args, false, false);
let c1 = c1.id;

fail call c1.makeChild(0);
Expand All @@ -63,11 +63,11 @@ let S = install(wasm, null, opt 100_000_000_000_000);
let nonce = record { timestamp = 1 : int; nonce = 1 : nat };
let c1 = call S.getCanisterId(nonce);
let args = record { arg = blob ""; wasm_module = parent; mode = variant { install }; canister_id = c1.id };
call S.installCode(c1, args, false);
call S.installCode(c1, args, false, false);

let c2 = call S.getCanisterId(nonce);
let args = record { arg = blob ""; wasm_module = deleter; mode = variant { install }; canister_id = c2.id };
call S.installCode(c2, args, false);
call S.installCode(c2, args, false, false);

let c1 = c1.id;
let c2 = c2.id;
Expand Down
2 changes: 1 addition & 1 deletion service/pool/tests/canisterPool.test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ let init = opt record {
let S = install(wasm, init, null);
let nonce = record { timestamp = 1 : int; nonce = 1 : nat };
let CID = call S.getCanisterId(nonce);
call S.installCode(CID, record { arg = blob ""; wasm_module = empty_wasm; mode = variant { install }; canister_id = CID.id }, false);
call S.installCode(CID, record { arg = blob ""; wasm_module = empty_wasm; mode = variant { install }; canister_id = CID.id }, false, false);
metadata(CID.id, "module_hash");

// Immediately expire
Expand Down
2 changes: 2 additions & 0 deletions service/wasm-utils/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions service/wasm-utils/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ path = "lib.rs"
crate-type = ["cdylib"]

[dependencies]
hex = "0.4.3"
ic-cdk = "0.8.0-beta.0"
ic-cdk-macros = "0.8.0-beta.0"
serde = "1.0"
serde_bytes = "0.11"
candid = "0.9.0-beta.2"
ic-wasm = { version = "0.3.7", default-features = false }
sha2 = "0.10.6"
walrus = "0.19"

[profile.release]
Expand Down
15 changes: 15 additions & 0 deletions service/wasm-utils/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use candid::{CandidType, Deserialize};
use serde_bytes::ByteBuf;

use ic_wasm::*;
use sha2::Digest;

#[derive(CandidType, Deserialize)]
struct Config {
Expand All @@ -11,6 +12,20 @@ struct Config {
backend_canister_id: Option<candid::Principal>,
}

const WHITELISTED_WASMS: [&str; 1] = [
"651425d92d3796ddae581191452e0e87484eeff4ff6352fe9a59c7e1f97a2310", // dfx 0.14.1 frontend canister
];

#[ic_cdk_macros::query]
fn is_whitelisted(wasm: ByteBuf) -> ByteBuf {
let wasm_hash = hex::encode(sha2::Sha256::digest(&wasm));
if WHITELISTED_WASMS.contains(&wasm_hash.as_str()) {
wasm
} else {
ic_cdk::trap("Wasm is not whitelisted")
}
}

#[ic_cdk_macros::query]
fn transform(wasm: ByteBuf, config: Config) -> ByteBuf {
let mut m = walrus::Module::from_buffer(&wasm).unwrap();
Expand Down
10 changes: 8 additions & 2 deletions service/wasm-utils/wasm-utils.did
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
type Config = record { profiling: bool; remove_cycles_add: bool; limit_stable_memory_page: opt nat32; backend_canister_id: opt principal};
type Config = record {
profiling : bool;
remove_cycles_add : bool;
limit_stable_memory_page : opt nat32;
backend_canister_id : opt principal;
};

service : {
transform : (blob, Config) -> (blob);
transform : (blob, Config) -> (blob) query;
is_whitelisted : (blob) -> (blob) query;
}
3 changes: 2 additions & 1 deletion src/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,8 @@ async function install(
const new_info = await backend.installCode(
canisterInfo,
installArgs,
profiling
profiling,
false
);
canisterInfo = new_info;
logger.log(`Code installed at canister id ${canisterInfo.id}`);
Expand Down
2 changes: 1 addition & 1 deletion src/declarations/backend/backend.did
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ type Self =
vec CanisterInfo;
}) query;
http_request: (HttpRequest) -> (HttpResponse) query;
installCode: (CanisterInfo, InstallArgs, bool) -> (CanisterInfo);
installCode: (CanisterInfo, InstallArgs, bool, bool) -> (CanisterInfo);
install_code:
(record {
arg: blob;
Expand Down
5 changes: 4 additions & 1 deletion src/declarations/backend/backend.did.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,10 @@ export interface Self {
Array<[Principal, Array<CanisterInfo>]>
>;
http_request: ActorMethod<[HttpRequest], HttpResponse>;
installCode: ActorMethod<[CanisterInfo, InstallArgs, boolean], CanisterInfo>;
installCode: ActorMethod<
[CanisterInfo, InstallArgs, boolean, boolean],
CanisterInfo
>;
install_code: ActorMethod<
[
{
Expand Down
2 changes: 1 addition & 1 deletion src/declarations/backend/backend.did.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export const idlFactory = ({ IDL }) => {
),
http_request: IDL.Func([HttpRequest], [HttpResponse], ["query"]),
installCode: IDL.Func(
[CanisterInfo, InstallArgs, IDL.Bool],
[CanisterInfo, InstallArgs, IDL.Bool, IDL.Bool],
[CanisterInfo],
[]
),
Expand Down
10 changes: 8 additions & 2 deletions src/declarations/wasm-utils/wasm-utils.did
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
type Config = record { profiling: bool; remove_cycles_add: bool; limit_stable_memory_page: opt nat32; backend_canister_id: opt principal};
type Config = record {
profiling : bool;
remove_cycles_add : bool;
limit_stable_memory_page : opt nat32;
backend_canister_id : opt principal;
};

service : {
transform : (blob, Config) -> (blob);
transform : (blob, Config) -> (blob) query;
is_whitelisted : (blob) -> (blob) query;
}
1 change: 1 addition & 0 deletions src/declarations/wasm-utils/wasm-utils.did.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export interface Config {
limit_stable_memory_page: [] | [number];
}
export interface _SERVICE {
is_whitelisted: ActorMethod<[Uint8Array | number[]], Uint8Array | number[]>;
transform: ActorMethod<
[Uint8Array | number[], Config],
Uint8Array | number[]
Expand Down
11 changes: 10 additions & 1 deletion src/declarations/wasm-utils/wasm-utils.did.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,16 @@ export const idlFactory = ({ IDL }) => {
limit_stable_memory_page: IDL.Opt(IDL.Nat32),
});
return IDL.Service({
transform: IDL.Func([IDL.Vec(IDL.Nat8), Config], [IDL.Vec(IDL.Nat8)], []),
is_whitelisted: IDL.Func(
[IDL.Vec(IDL.Nat8)],
[IDL.Vec(IDL.Nat8)],
["query"]
),
transform: IDL.Func(
[IDL.Vec(IDL.Nat8), Config],
[IDL.Vec(IDL.Nat8)],
["query"]
),
});
};
export const init = ({ IDL }) => {
Expand Down
Loading