Skip to content
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
1 change: 1 addition & 0 deletions Cargo.lock

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

3 changes: 2 additions & 1 deletion crates/gem_ton/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ rpc = [
"dep:chain_traits",
"dep:futures",
]
signer = ["dep:signer"]
signer = ["dep:signer", "dep:gem_hash"]
reqwest = ["gem_client/reqwest"]
chain_integration_tests = ["rpc", "reqwest", "settings/testkit"]

Expand All @@ -35,6 +35,7 @@ futures = { workspace = true, optional = true }

# Optional signer dependencies
signer = { path = "../signer", optional = true }
gem_hash = { path = "../gem_hash", optional = true }

[dev-dependencies]
tokio = { workspace = true, features = ["macros", "rt"] }
Expand Down
47 changes: 31 additions & 16 deletions crates/gem_ton/src/address.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use base64::prelude::{BASE64_URL_SAFE_NO_PAD, Engine};
use base64::prelude::{BASE64_STANDARD_NO_PAD, BASE64_URL_SAFE_NO_PAD, Engine};
use crc::Crc;

type Workchain = i32;
Expand Down Expand Up @@ -34,10 +34,30 @@ impl Address {
Self { workchain, hash_part }
}

pub fn workchain(&self) -> Workchain {
self.workchain
}

pub fn get_hash_part(&self) -> &HashPart {
&self.hash_part
}

pub fn from_base64_url(base64: &str) -> Result<Self, ParseError> {
let bytes = BASE64_URL_SAFE_NO_PAD
.decode(base64)
.or_else(|_| BASE64_STANDARD_NO_PAD.decode(base64))
.map_err(|_| ParseError("Invalid base64".to_string()))?;

if bytes.len() != 36 {
return Err(ParseError("Invalid base64 address length".to_string()));
}

let workchain = bytes[1] as i8 as i32;
let hash_part: HashPart = bytes[2..34].try_into().map_err(|_| ParseError("Invalid hash length".to_string()))?;

Ok(Self { workchain, hash_part })
}
Comment on lines +45 to +59
Copy link
Contributor

Choose a reason for hiding this comment

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

security-medium medium

The Address::from_base64_url function decodes a base64-encoded TON address but critically fails to validate the 2-byte CRC checksum, which is a standard part of the 36-byte TON user-friendly address format. This omission allows the application to accept malformed addresses or addresses with typos, potentially leading to signing messages for unintended accounts or displaying incorrect information. Beyond this, the function's name from_base64_url suggests it only handles URL-safe base64, but it falls back to decoding standard base64 if URL-safe decoding fails. This behavior, while robust, might obscure issues with data sources expected to provide URL-safe base64. If both formats are intentionally supported, this should be clearly documented; otherwise, the fallback should be removed to enforce the correct format. Remediation: Implement CRC16-CCITT validation to verify that the last 2 bytes of the decoded 36-byte array match the CRC16-CCITT checksum of the first 34 bytes.


pub fn from_hex_str<S>(hex_str: S) -> Result<Self, ParseError>
where
S: AsRef<str>,
Expand Down Expand Up @@ -73,21 +93,8 @@ pub fn hex_to_base64_address(hex_str: String) -> Result<String, Box<dyn std::err
}

pub fn base64_to_hex_address(base64_str: String) -> Result<String, Box<dyn std::error::Error + Send + Sync>> {
use base64::prelude::{BASE64_STANDARD_NO_PAD, BASE64_URL_SAFE_NO_PAD};

let bytes = BASE64_URL_SAFE_NO_PAD
.decode(&base64_str)
.or_else(|_| BASE64_STANDARD_NO_PAD.decode(&base64_str))
.map_err(|_| ParseError("Invalid base64".to_string()))?;

if bytes.len() != 36 {
return Err(ParseError("Invalid base64 length".to_string()).into());
}

let workchain = bytes[1] as i32;
let hash = &bytes[2..34];

Ok(format!("{}:{}", workchain, hex::encode(hash)))
let address = Address::from_base64_url(&base64_str)?;
Ok(format!("{}:{}", address.workchain(), hex::encode(address.get_hash_part())))
}

impl std::error::Error for ParseError {}
Expand Down Expand Up @@ -164,6 +171,14 @@ mod tests {
assert_eq!(hex, "0:8e874b7ad9bbebbfc48810b8939c98f50580246f19982040dbcb253c4c3daf78");
}

#[test]
fn test_from_base64_url() {
let addr = Address::from_base64_url("UQBY1cVPu4SIr36q0M3HWcqPb_efyVVRBsEzmwN-wKQDR6zg").unwrap();

assert_eq!(addr.workchain(), 0);
assert_eq!(hex::encode(addr.get_hash_part()), "58d5c54fbb8488af7eaad0cdc759ca8f6ff79fc9555106c1339b037ec0a40347");
}

#[test]
fn test_round_trip_conversion() {
let original_hex = "0:0e97797708411c29a3cb1f3f810ef4f83f41d990838f7f93ce7082c4ff9aa026";
Expand Down
10 changes: 8 additions & 2 deletions crates/gem_ton/src/signer/chain_signer.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
use std::time::{SystemTime, UNIX_EPOCH};

use primitives::{ChainSigner, SignerError, TransactionLoadInput};

use super::signature::sign_personal;
Expand All @@ -7,8 +9,12 @@ pub struct TonChainSigner;

impl ChainSigner for TonChainSigner {
fn sign_message(&self, message: &[u8], private_key: &[u8]) -> Result<String, SignerError> {
let (signature, _public_key) = sign_personal(message, private_key)?;
Ok(base64::Engine::encode(&base64::engine::general_purpose::STANDARD, signature))
let timestamp = SystemTime::now()
.duration_since(UNIX_EPOCH)
.map_err(|e| SignerError::InvalidInput(e.to_string()))?
.as_secs();
let result = sign_personal(message, private_key, timestamp)?;
Ok(base64::Engine::encode(&base64::engine::general_purpose::STANDARD, result.signature))
}

fn sign_transfer(&self, input: &TransactionLoadInput, private_key: &[u8]) -> Result<String, SignerError> {
Expand Down
4 changes: 3 additions & 1 deletion crates/gem_ton/src/signer/mod.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
mod chain_signer;
mod signature;
#[cfg(test)]
pub(crate) mod testkit;
mod types;

pub use chain_signer::TonChainSigner;
pub use signature::sign_personal;
pub use types::{TonSignDataPayload, TonSignDataResponse, TonSignMessageData};
pub use types::{TonSignDataPayload, TonSignDataResponse, TonSignMessageData, TonSignResult};
29 changes: 18 additions & 11 deletions crates/gem_ton/src/signer/signature.rs
Original file line number Diff line number Diff line change
@@ -1,41 +1,48 @@
use primitives::SignerError;
use signer::Signer;

use super::types::TonSignMessageData;
use super::types::{TonSignMessageData, TonSignResult};

pub fn sign_personal(data: &[u8], private_key: &[u8]) -> Result<(Vec<u8>, Vec<u8>), SignerError> {
pub fn sign_personal(data: &[u8], private_key: &[u8], timestamp: u64) -> Result<TonSignResult, SignerError> {
let ton_data = TonSignMessageData::from_bytes(data)?;
let digest = ton_data.payload.hash();
let digest = ton_data.hash(timestamp)?;

Signer::sign_ed25519_with_public_key(&digest, private_key).map_err(|e| SignerError::InvalidInput(e.to_string()))
let (signature, public_key) = Signer::sign_ed25519_with_public_key(&digest, private_key).map_err(|e| SignerError::InvalidInput(e.to_string()))?;
Ok(TonSignResult { signature, public_key, timestamp })
}

#[cfg(test)]
mod tests {
use super::*;
use crate::signer::TonSignDataPayload;
use crate::signer::testkit::TEST_ADDRESS;

#[test]
fn test_sign_ton_personal() {
let payload = TonSignDataPayload::Text { text: "Hello TON".to_string() };
let ton_data = TonSignMessageData::new(payload, "example.com".to_string());
let ton_data = TonSignMessageData::new(payload, "example.com".to_string(), TEST_ADDRESS.to_string());
let data = ton_data.to_bytes();

let private_key = hex::decode("1e9d38b5274152a78dff1a86fa464ceadc1f4238ca2c17060c3c507349424a34").expect("valid hex");
let private_key = hex::decode("1e9d38b5274152a78dff1a86fa464ceadc1f4238ca2c17060c3c507349424a34").unwrap();
let timestamp = 1234567890u64;

let (signature, public_key) = sign_personal(&data, &private_key).expect("signing succeeds");
let result = sign_personal(&data, &private_key, timestamp).unwrap();

assert_eq!(signature.len(), 64, "Ed25519 signature should be 64 bytes");
assert_eq!(public_key.len(), 32, "Ed25519 public key should be 32 bytes");
assert_eq!(
hex::encode(&result.signature),
"3fe42db1d77534ba52d43240cf6b84b36eb1c53a28e3370c5872f37558cee9b758b9f93a8740c84ee4190b99de83901dcb9d5b42b1c7826b3836236ef5cd3a0f"
);
assert_eq!(hex::encode(&result.public_key), "d369452197c2a56481e5e2d3e8bf03de2349f67a63151956822208c2334adee2");
assert_eq!(result.timestamp, timestamp);
}

#[test]
fn test_sign_ton_personal_rejects_invalid_key() {
let payload = TonSignDataPayload::Text { text: "Hello TON".to_string() };
let ton_data = TonSignMessageData::new(payload, "example.com".to_string());
let ton_data = TonSignMessageData::new(payload, "example.com".to_string(), TEST_ADDRESS.to_string());
let data = ton_data.to_bytes();

let result = sign_personal(&data, &[0u8; 16]);
let result = sign_personal(&data, &[0u8; 16], 1234567890);
assert!(result.is_err());
}
}
1 change: 1 addition & 0 deletions crates/gem_ton/src/signer/testkit.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub const TEST_ADDRESS: &str = "UQBY1cVPu4SIr36q0M3HWcqPb_efyVVRBsEzmwN-wKQDR6zg";
88 changes: 72 additions & 16 deletions crates/gem_ton/src/signer/types.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
use base64::Engine;
use base64::engine::general_purpose::STANDARD as BASE64;
use gem_hash::sha2::sha256;
use primitives::SignerError;
use serde::{Deserialize, Serialize};

use crate::address::Address;

const SIGN_DATA_PREFIX: &[u8] = b"\xff\xffton-connect/sign-data/";

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "lowercase")]
pub enum TonSignDataPayload {
Expand All @@ -18,8 +25,12 @@ impl TonSignDataPayload {
}
}

pub fn hash(&self) -> Vec<u8> {
self.data().as_bytes().to_vec()
pub fn encode(&self) -> Result<(&str, Vec<u8>), SignerError> {
match self {
Self::Text { text } => Ok(("txt", text.as_bytes().to_vec())),
Self::Binary { bytes } => Ok(("bin", BASE64.decode(bytes).map_err(|e| SignerError::InvalidInput(e.to_string()))?)),
Self::Cell { .. } => Err(SignerError::InvalidInput("Cell payload not supported for sign-data".to_string())),
}
}
}

Expand All @@ -28,6 +39,7 @@ impl TonSignDataPayload {
pub struct TonSignDataResponse {
signature: String,
public_key: String,
address: String,
timestamp: u64,
domain: String,
payload: TonSignDataPayload,
Expand All @@ -37,16 +49,17 @@ pub struct TonSignDataResponse {
pub struct TonSignMessageData {
pub payload: TonSignDataPayload,
pub domain: String,
pub address: String,
}

impl TonSignMessageData {
pub fn new(payload: TonSignDataPayload, domain: String) -> Self {
Self { payload, domain }
pub fn new(payload: TonSignDataPayload, domain: String, address: String) -> Self {
Self { payload, domain, address }
}

pub fn from_value(payload: serde_json::Value, domain: String) -> Result<Self, SignerError> {
pub fn from_value(payload: serde_json::Value, domain: String, address: String) -> Result<Self, SignerError> {
let payload: TonSignDataPayload = serde_json::from_value(payload).map_err(SignerError::from)?;
Ok(Self { payload, domain })
Ok(Self { payload, domain, address })
}

pub fn from_bytes(data: &[u8]) -> Result<Self, SignerError> {
Expand All @@ -56,13 +69,39 @@ impl TonSignMessageData {
pub fn to_bytes(&self) -> Vec<u8> {
serde_json::to_vec(self).unwrap_or_default()
}

pub fn hash(&self, timestamp: u64) -> Result<Vec<u8>, SignerError> {
let address = Address::from_base64_url(&self.address).map_err(|e| SignerError::InvalidInput(e.to_string()))?;
let domain_bytes = self.domain.as_bytes();
let (type_prefix, payload_bytes) = self.payload.encode()?;

let mut msg = Vec::new();
msg.extend_from_slice(SIGN_DATA_PREFIX);
msg.extend_from_slice(&address.workchain().to_be_bytes());
msg.extend_from_slice(address.get_hash_part());
msg.extend_from_slice(&(domain_bytes.len() as u32).to_be_bytes());
msg.extend_from_slice(domain_bytes);
msg.extend_from_slice(&timestamp.to_be_bytes());
msg.extend_from_slice(type_prefix.as_bytes());
msg.extend_from_slice(&(payload_bytes.len() as u32).to_be_bytes());
msg.extend_from_slice(&payload_bytes);

Ok(sha256(&msg).to_vec())
}
}

pub struct TonSignResult {
pub signature: Vec<u8>,
pub public_key: Vec<u8>,
pub timestamp: u64,
}

impl TonSignDataResponse {
pub fn new(signature: String, public_key: String, timestamp: u64, domain: String, payload: TonSignDataPayload) -> Self {
pub fn new(signature: String, public_key: String, address: String, timestamp: u64, domain: String, payload: TonSignDataPayload) -> Self {
Self {
signature,
public_key,
address,
timestamp,
domain,
payload,
Expand All @@ -77,14 +116,14 @@ impl TonSignDataResponse {
#[cfg(test)]
mod tests {
use super::*;
use crate::signer::testkit::TEST_ADDRESS;

#[test]
fn test_parse_payload_text() {
let json = r#"{"type":"text","text":"Hello TON"}"#;
let parsed: TonSignDataPayload = serde_json::from_str(json).unwrap();

assert_eq!(parsed, TonSignDataPayload::Text { text: "Hello TON".to_string() });
assert_eq!(b"Hello TON".to_vec(), parsed.hash());
}

#[test]
Expand All @@ -93,7 +132,6 @@ mod tests {
let parsed: TonSignDataPayload = serde_json::from_str(json).unwrap();

assert_eq!(parsed, TonSignDataPayload::Binary { bytes: "SGVsbG8=".to_string() });
assert_eq!("SGVsbG8=".as_bytes().to_vec(), parsed.hash());
}

#[test]
Expand All @@ -102,20 +140,27 @@ mod tests {
let parsed: TonSignDataPayload = serde_json::from_str(json).unwrap();

assert_eq!(parsed, TonSignDataPayload::Cell { cell: "te6c".to_string() });
assert_eq!("te6c".as_bytes().to_vec(), parsed.hash());
}

#[test]
fn test_response_to_json() {
let payload = TonSignDataPayload::Text { text: "Hello TON".to_string() };

let response = TonSignDataResponse::new("c2lnbmF0dXJl".to_string(), "cHVibGljS2V5".to_string(), 1234567890, "example.com".to_string(), payload);
let response = TonSignDataResponse::new(
"c2lnbmF0dXJl".to_string(),
"abcdef01".to_string(),
"0:58d5c54fbb8488af7eaad0cdc759ca8f6ff79fc9555106c1339b037ec0a40347".to_string(),
1234567890,
"example.com".to_string(),
payload,
);

let json = response.to_json().unwrap();
let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

assert_eq!(parsed["signature"], "c2lnbmF0dXJl");
assert_eq!(parsed["publicKey"], "cHVibGljS2V5");
assert_eq!(parsed["publicKey"], "abcdef01");
assert_eq!(parsed["address"], "0:58d5c54fbb8488af7eaad0cdc759ca8f6ff79fc9555106c1339b037ec0a40347");
assert_eq!(parsed["timestamp"], 1234567890);
assert_eq!(parsed["domain"], "example.com");
assert_eq!(parsed["payload"]["type"], "text");
Expand All @@ -125,20 +170,31 @@ mod tests {
#[test]
fn test_ton_sign_message_data() {
let payload = TonSignDataPayload::Text { text: "Hello TON".to_string() };
let data = TonSignMessageData::new(payload.clone(), "example.com".to_string());
let data = TonSignMessageData::new(payload.clone(), "example.com".to_string(), TEST_ADDRESS.to_string());

let bytes = data.to_bytes();
let parsed = TonSignMessageData::from_bytes(&bytes).unwrap();

assert_eq!(parsed.payload, payload);
assert_eq!(parsed.domain, "example.com");
assert_eq!(parsed.address, TEST_ADDRESS);
}

#[test]
fn test_ton_sign_message_data_get_payload() {
fn test_build_sign_data_hash() {
let payload = TonSignDataPayload::Text { text: "Hello TON".to_string() };
let data = TonSignMessageData::new(payload, "example.com".to_string());
let data = TonSignMessageData::new(payload, "example.com".to_string(), TEST_ADDRESS.to_string());

let hash = data.hash(1234567890).unwrap();

assert_eq!(hash.len(), 32);
}

#[test]
fn test_build_sign_data_hash_cell_unsupported() {
let payload = TonSignDataPayload::Cell { cell: "te6c".to_string() };
let data = TonSignMessageData::new(payload, "example.com".to_string(), TEST_ADDRESS.to_string());

assert_eq!(data.payload, TonSignDataPayload::Text { text: "Hello TON".to_string() });
assert!(data.hash(1234567890).is_err());
}
}
Loading
Loading