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.

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

Limit vec #1530

Merged
merged 2 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export function primitiveCandidDefinitionArb(
{ arbitrary: Nat16DefinitionArb(), weight: constraints.nat16 ?? 1 },
{ arbitrary: Nat32DefinitionArb(), weight: constraints.nat32 ?? 1 },
{ arbitrary: Nat64DefinitionArb(), weight: constraints.nat64 ?? 1 },
{ arbitrary: NullDefinitionArb(), weight: constraints.null ?? 0 }, // TODO Null must be excluded until https://github.com/demergent-labs/azle/issues/1453 gets resolved
{ arbitrary: NullDefinitionArb(), weight: constraints.null ?? 1 },
{ arbitrary: TextDefinitionArb(), weight: constraints.text ?? 1 },
{
arbitrary: PrincipalDefinitionArb(),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
import fc from 'fast-check';
import fc, { ArrayConstraints } from 'fast-check';
import { Vec } from '.';
import { CandidType } from '../../candid_type';
import { CorrespondingJSType } from '../../corresponding_js_type';
import { VecCandidDefinition } from '../../candid_definition_arb/types';
import {
CandidDefinition,
OptCandidDefinition,
RecordCandidDefinition,
TupleCandidDefinition,
VariantCandidDefinition,
VecCandidDefinition
} from '../../candid_definition_arb/types';
import { CandidValues, CandidValueArb } from '../../candid_values_arb';
import { RecursiveShapes } from '../../recursive';

/*
https://github.com/dfinity/candid/blob/491969f34dd791e51f69c5f8d3c6192ae405b839/spec/Candid.md#memory
Set size limit to follow candid spec
const NULL_VEC_SIZE_LIMIT = 2_000_000;
*/
// TODO set to zero until the limit is unified on both the canister and client side as per https://github.com/demergent-labs/azle/issues/1538
const EMPTYISH_VEC_SIZE_LIMIT = 0;

export function VecValuesArb(
vecDefinition: VecCandidDefinition,
recursiveShapes: RecursiveShapes,
Expand All @@ -18,7 +33,7 @@ export function VecValuesArb(
}
const arbitraryMemberValues = fc
.tuple(
fc.array(fc.constant(null)),
fc.array(fc.constant(null), determineVecConstraints(vecDefinition)),
fc.constant(vecDefinition.innerType)
)
.chain(([arrayTemplate, innerType]) =>
Expand Down Expand Up @@ -47,6 +62,15 @@ export function VecValuesArb(
});
}

function determineVecConstraints(
vecDefinition: VecCandidDefinition
): ArrayConstraints | undefined {
if (isEmptyInnerType(vecDefinition.innerType)) {
return { maxLength: EMPTYISH_VEC_SIZE_LIMIT };
}
return;
}

function generateEmptyVec(innerCandidType: CandidType): CandidValues<Vec> {
return {
valueLiteral: typeValueLiteral('[]', innerCandidType),
Expand Down Expand Up @@ -148,3 +172,54 @@ function typeArray<T extends CorrespondingJSType>(

return arr;
}

/**
* In order to prevent DoS attacks empty inner types can only be of length 0.
* Empty types are null, empty record, empty tuple, record with one field that
* is a null, tuple with one field that is a null.
* Lets start with a vec or null, or vec or tuple where all the fields are null,
* or vec or record where all things are null or vec or variant where things are
* null
* https://github.com/demergent-labs/azle/issues/1524
* @param innerType
* @returns
*/
function isEmptyInnerType(innerType: CandidDefinition): boolean {
if (innerType.candidMeta.candidType === 'Null') {
return true;
}
if (
innerType.candidMeta.candidType === 'Record' ||
innerType.candidMeta.candidType === 'Tuple' ||
innerType.candidMeta.candidType === 'Variant' ||
innerType.candidMeta.candidType === 'Opt'
) {
return areAllFieldsNull(innerType);
}
return false;
}

function areAllFieldsNull(innerType: CandidDefinition): boolean {
if (
innerType.candidMeta.candidType === 'Record' ||
innerType.candidMeta.candidType === 'Variant'
) {
const multiInnerType = innerType as
| RecordCandidDefinition
| VariantCandidDefinition;
return multiInnerType.innerTypes.every((innerType) =>
isEmptyInnerType(innerType[1])
);
}
if (innerType.candidMeta.candidType === 'Tuple') {
const multiInnerType = innerType as TupleCandidDefinition;
return multiInnerType.innerTypes.every((innerType) =>
isEmptyInnerType(innerType)
);
}
if (innerType.candidMeta.candidType === 'Opt') {
const optInnerType = innerType as OptCandidDefinition;
return isEmptyInnerType(optInnerType.innerType);
}
return false;
}
Loading