Skip to content

fix(platform)!: ensure correct critical security level for token transitions and allow any security level key in signing if allowed to do so with options #2597

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

Merged
QuantumExplorer merged 10 commits into from
May 8, 2025
Merged

fix(platform)!: ensure correct critical security level for token transitions and allow any security level key in signing if allowed to do so with options #2597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
285bc5a
fix: ensure correct security level for token transitions
QuantumExplorer May 8, 2025
23d47e0
added methods to sign with invalid keys
QuantumExplorer May 8, 2025
8e7b3b1
added ability to say in sdk that we are are signing with non valid key
QuantumExplorer May 8, 2025
33facd8
fix
QuantumExplorer May 8, 2025
72f5664
cleaner required security level requirement
QuantumExplorer May 8, 2025
0e0bb2a
cleaner required security level requirement
QuantumExplorer May 8, 2025
530fd79
fix
QuantumExplorer May 8, 2025
7a1e6b9
fix
QuantumExplorer May 8, 2025
f379e8a
fix
QuantumExplorer May 8, 2025
e446ec9
fixes
QuantumExplorer May 8, 2025
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
116 changes: 79 additions & 37 deletions packages/rs-dpp/src/state_transition/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,32 +210,32 @@ macro_rules! call_method_identity_signed {

#[cfg(feature = "state-transition-signing")]
macro_rules! call_errorable_method_identity_signed {
($state_transition:expr, $method:ident, $args:tt ) => {
($state_transition:expr, $method:ident, $( $arg:expr ),* ) => {
match $state_transition {
StateTransition::DataContractCreate(st) => st.$method($args),
StateTransition::DataContractUpdate(st) => st.$method($args),
StateTransition::Batch(st) => st.$method($args),
StateTransition::IdentityCreate(_st) => Err(ProtocolError::CorruptedCodeExecution(
StateTransition::DataContractCreate(st) => st.$method($( $arg ),*),
StateTransition::DataContractUpdate(st) => st.$method($( $arg ),*),
StateTransition::Batch(st) => st.$method($( $arg ),*),
StateTransition::IdentityCreate(_) => Err(ProtocolError::CorruptedCodeExecution(
"identity create can not be called for identity signing".to_string(),
)),
StateTransition::IdentityTopUp(_st) => Err(ProtocolError::CorruptedCodeExecution(
StateTransition::IdentityTopUp(_) => Err(ProtocolError::CorruptedCodeExecution(
"identity top up can not be called for identity signing".to_string(),
)),
StateTransition::IdentityCreditWithdrawal(st) => st.$method($args),
StateTransition::IdentityUpdate(st) => st.$method($args),
StateTransition::IdentityCreditTransfer(st) => st.$method($args),
StateTransition::MasternodeVote(st) => st.$method($args),
StateTransition::IdentityCreditWithdrawal(st) => st.$method($( $arg ),*),
StateTransition::IdentityUpdate(st) => st.$method($( $arg ),*),
StateTransition::IdentityCreditTransfer(st) => st.$method($( $arg ),*),
StateTransition::MasternodeVote(st) => st.$method($( $arg ),*),
}
};
($state_transition:expr, $method:ident ) => {
($state_transition:expr, $method:ident) => {
match $state_transition {
StateTransition::DataContractCreate(st) => st.$method(),
StateTransition::DataContractUpdate(st) => st.$method(),
StateTransition::Batch(st) => st.$method(),
StateTransition::IdentityCreate(st) => Err(ProtocolError::CorruptedCodeExecution(
StateTransition::IdentityCreate(_) => Err(ProtocolError::CorruptedCodeExecution(
"identity create can not be called for identity signing".to_string(),
)),
StateTransition::IdentityTopUp(st) => Err(ProtocolError::CorruptedCodeExecution(
StateTransition::IdentityTopUp(_) => Err(ProtocolError::CorruptedCodeExecution(
"identity top up can not be called for identity signing".to_string(),
)),
StateTransition::IdentityCreditWithdrawal(st) => st.$method(),
Expand Down Expand Up @@ -282,6 +282,15 @@ impl OptionallyAssetLockProved for StateTransition {
}
}

/// The state transition signing options
#[derive(Debug, Clone, Copy, Default, Eq, PartialEq)]
pub struct StateTransitionSigningOptions {
/// This will allow signing with any security level for debugging purposes
pub allow_signing_with_any_security_level: bool,
/// This will allow signing with any purpose for debugging purposes
pub allow_signing_with_any_purpose: bool,
}

impl StateTransition {
pub fn deserialize_from_bytes_in_version(
bytes: &[u8],
Expand Down Expand Up @@ -508,54 +517,70 @@ impl StateTransition {
get_data_contract_security_level_requirement: Option<
impl Fn(Identifier, String) -> Result<SecurityLevel, ProtocolError>,
>,
) -> Result<(), ProtocolError> {
self.sign_external_with_options(
identity_public_key,
signer,
get_data_contract_security_level_requirement,
StateTransitionSigningOptions::default(),
)
}

#[cfg(feature = "state-transition-signing")]
pub fn sign_external_with_options<S: Signer>(
&mut self,
identity_public_key: &IdentityPublicKey,
signer: &S,
get_data_contract_security_level_requirement: Option<
impl Fn(Identifier, String) -> Result<SecurityLevel, ProtocolError>,
>,
options: StateTransitionSigningOptions,
) -> Result<(), ProtocolError> {
match self {
StateTransition::DataContractCreate(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::DataContractUpdate(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::Batch(st) => {
if identity_public_key.purpose() != Purpose::AUTHENTICATION {
if !options.allow_signing_with_any_purpose
&& identity_public_key.purpose() != Purpose::AUTHENTICATION
{
return Err(ProtocolError::WrongPublicKeyPurposeError(
WrongPublicKeyPurposeError::new(
identity_public_key.purpose(),
vec![Purpose::AUTHENTICATION],
),
));
}
let get_data_contract_security_level_requirement =
get_data_contract_security_level_requirement
.ok_or(ProtocolError::CorruptedCodeExecution(
"must supply get_data_contract when signing a documents batch transition"
.to_string(),
))?;
let security_level_requirement = st.contract_based_security_level_requirement(
get_data_contract_security_level_requirement,
)?;
if !security_level_requirement.contains(&identity_public_key.security_level()) {
return Err(ProtocolError::InvalidSignaturePublicKeySecurityLevelError(
InvalidSignaturePublicKeySecurityLevelError::new(
identity_public_key.security_level(),
security_level_requirement,
),
));
if !options.allow_signing_with_any_security_level {
let security_level_requirement = st.combined_security_level_requirement(
get_data_contract_security_level_requirement,
)?;
if !security_level_requirement.contains(&identity_public_key.security_level()) {
return Err(ProtocolError::InvalidSignaturePublicKeySecurityLevelError(
InvalidSignaturePublicKeySecurityLevelError::new(
identity_public_key.security_level(),
security_level_requirement,
),
));
}
}
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::IdentityCreditWithdrawal(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::IdentityUpdate(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::IdentityCreditTransfer(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
StateTransition::IdentityCreate(_) => {
Expand All @@ -569,7 +594,7 @@ impl StateTransition {
))
}
StateTransition::MasternodeVote(st) => {
st.verify_public_key_level_and_purpose(identity_public_key)?;
st.verify_public_key_level_and_purpose(identity_public_key, options)?;
st.verify_public_key_is_enabled(identity_public_key)?;
}
}
Expand All @@ -585,11 +610,28 @@ impl StateTransition {
identity_public_key: &IdentityPublicKey,
private_key: &[u8],
bls: &impl BlsModule,
) -> Result<(), ProtocolError> {
self.sign_with_options(
identity_public_key,
private_key,
bls,
StateTransitionSigningOptions::default(),
)
}

#[cfg(feature = "state-transition-signing")]
pub fn sign_with_options(
&mut self,
identity_public_key: &IdentityPublicKey,
private_key: &[u8],
bls: &impl BlsModule,
options: StateTransitionSigningOptions,
) -> Result<(), ProtocolError> {
call_errorable_method_identity_signed!(
self,
verify_public_key_level_and_purpose,
identity_public_key
identity_public_key,
options
)?;
call_errorable_method_identity_signed!(
self,
Expand Down
Loading