1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
use std::collections::HashMap;
use std::rc::Rc;
use soroban_env_common::xdr::{
ContractAuth, ContractDataEntry, HashIdPreimage, HashIdPreimageContractAuth, LedgerEntry,
LedgerEntryData, LedgerEntryExt, ScAddress, ScHostAuthErrorCode, ScNonceKey, ScSymbol, ScVal,
};
use soroban_env_common::RawVal;
use crate::budget::Budget;
use crate::host::metered_clone::MeteredClone;
use crate::host::Frame;
use crate::native_contract::account_contract::{
check_account_authentication, check_account_contract_auth,
};
use crate::{Host, HostError};
use super::xdr;
use super::xdr::{Hash, ScUnknownErrorCode, ScVec};
// Authorization manager encapsulates host-based authentication & authorization
// framework.
// This supports enforcing authentication & authorization of the contract
// invocation trees as well as recording the authorization requirements in
// simulated environments (such as tests or preflight).
#[derive(Clone)]
pub(crate) struct AuthorizationManager {
// Mode of operation of this AuthorizationManager. This can't be changed; in
// order to switch the mode a new instance of AuthorizationManager has to
// be created.
mode: AuthorizationMode,
// Per-address trackers of authorized invocations.
// Every tracker takes care about a single rooted invocation tree for some
// address. There can be multiple trackers per address.
trackers: Vec<AuthorizationTracker>,
// Current call stack consisting only of the contract invocations (i.e. not
// the host functions).
call_stack: Vec<ContractInvocation>,
budget: Budget,
}
// The authorization payload recorded for an address in the recording
// authorization mode.
#[derive(Eq, PartialEq, Debug)]
pub struct RecordedAuthPayload {
pub address: Option<ScAddress>,
pub nonce: Option<u64>,
pub invocation: xdr::AuthorizedInvocation,
}
// Snapshot of `AuthorizationManager` to use when performing the callstack
// rollbacks.
#[derive(Clone)]
pub struct AuthorizationManagerSnapshot {
// AuthorizationTracker has some immutable parts, but it is safer to just
// rollback everything. If this is an issue, then the AuthorizationTracker should
// probably be separated into 'mutable' and 'immutable' parts.
trackers: Vec<AuthorizationTracker>,
tracker_by_address_handle: Option<HashMap<u32, usize>>,
}
#[derive(Clone)]
enum AuthorizationMode {
Enforcing,
Recording(RecordingAuthInfo),
}
// Additional AuthorizationManager fields needed only for the recording mode.
#[derive(Clone)]
struct RecordingAuthInfo {
// Maps the `Address` object identifiers to the respective tracker indices
// in `trackers`
// This allows to disambiguate between the addresses that have the same
// value, but are specified as two different objects (e.g. as two different
// contract function inputs).
tracker_by_address_handle: HashMap<u32, usize>,
}
// Stores all the authorizations that are authorized by an address.
// In the enforcing mode this performs authentication and makes sure that only
// pre-authorized invocations can happen on behalf of the `address`.
// In the recording mode this will record the invocations that are authorized
// on behalf of the address.
#[derive(Clone)]
struct AuthorizationTracker {
// Tracked address. If `None`, then lazily set to the transaction source
// account's (i.e. invoker's) address is used.
address: Option<ScAddress>,
// Root of the authorized invocation tree.
// The authorized invocation tree only contains the contract invocations
// that explicitly require authorization on behalf of the address.
root_authorized_invocation: AuthorizedInvocation,
// Call stack that tracks the current walk in the tree of authorized
// invocations.
// This is set to `None` if the invocation didn't require authorization on
// behalf of the address.
// When not `None` this is an index of the authorized invocation in the
// parent's `sub_invocations` vector or 0 for the
// `root_authorized_invocation`.
invocation_id_in_call_stack: Vec<Option<usize>>,
// Arguments representing the signature(s) made by the address to authorize
// the invocations tracked here.
signature_args: Vec<RawVal>,
// Indicates whether this tracker is still valid. If invalidated once, this
// can't be used to authorize anything anymore
is_valid: bool,
// Indicates whether this is a tracker for the transaction invoker.
is_invoker: bool,
// Indicates whether authentication has already succesfully happened.
authenticated: bool,
// Indicates whether nonce still needs to be verified and consumed.
need_nonce: bool,
// The value of nonce authorized by the address. Must match the stored
// nonce value.
nonce: Option<u64>,
}
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) struct ContractInvocation {
pub(crate) contract_id: Hash,
pub(crate) function_name: ScSymbol,
}
// A single node in the authorized invocation tree.
// This represents an invocation and all it's authorized sub-invocations.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) struct AuthorizedInvocation {
pub(crate) contract_id: Hash,
pub(crate) function_name: ScSymbol,
pub(crate) args: ScVec,
pub(crate) sub_invocations: Vec<AuthorizedInvocation>,
// Indicates that this invocation has been already used in the
// enforcing mode. Exhausted authorizations can't be reused.
// In the recording mode this is immediately set to `true` (as the
// authorizations are recorded when the actually happen).
is_exhausted: bool,
}
impl AuthorizedInvocation {
fn from_xdr(xdr_invocation: xdr::AuthorizedInvocation) -> Result<Self, HostError> {
let sub_invocations_xdr = xdr_invocation.sub_invocations.into_vec();
let sub_invocations = sub_invocations_xdr
.into_iter()
.map(AuthorizedInvocation::from_xdr)
.collect::<Result<Vec<_>, _>>()?;
Ok(Self {
contract_id: xdr_invocation.contract_id,
function_name: xdr_invocation.function_name,
args: xdr_invocation.args,
sub_invocations,
is_exhausted: false,
})
}
fn to_xdr(&self, budget: &Budget) -> Result<xdr::AuthorizedInvocation, HostError> {
Ok(xdr::AuthorizedInvocation {
contract_id: self.contract_id.metered_clone(budget)?,
// This ideally should be infallible
function_name: self.function_name.clone(),
args: self.args.metered_clone(budget)?,
sub_invocations: self
.sub_invocations
.iter()
.map(|i| i.to_xdr(budget))
.collect::<Result<Vec<xdr::AuthorizedInvocation>, HostError>>()?
.try_into()
.map_err(|_| HostError::from(ScUnknownErrorCode::General))?,
})
}
fn new_recording(contract_id: &Hash, function_name: &ScSymbol, args: ScVec) -> Self {
Self {
contract_id: contract_id.clone(),
function_name: function_name.clone(),
args,
sub_invocations: vec![],
is_exhausted: true,
}
}
// Non-metered conversion should only be used for the recording preflight
// runs.
fn to_xdr_non_metered(&self) -> Result<xdr::AuthorizedInvocation, HostError> {
Ok(xdr::AuthorizedInvocation {
contract_id: self.contract_id.clone(),
// This ideally should be infallible
function_name: self.function_name.clone(),
args: self.args.clone(),
sub_invocations: self
.sub_invocations
.iter()
.map(|i| i.to_xdr_non_metered())
.collect::<Result<Vec<xdr::AuthorizedInvocation>, HostError>>()?
.try_into()
.map_err(|_| HostError::from(ScUnknownErrorCode::General))?,
})
}
// Walks a path in the tree defined by `invocation_id_in_call_stack` and
// returns the last visited authorized node.
fn last_authorized_invocation_mut(
&mut self,
invocation_id_in_call_stack: &Vec<Option<usize>>,
call_stack_id: usize,
) -> &mut AuthorizedInvocation {
// Start walking the stack from `call_stack_id`. We trust the callers to
// hold the invariant that `invocation_id_in_call_stack[call_stack_id - 1]`
// corresponds to this invocation tree, so that the next non-`None` child
// corresponds to the child of the current tree.
for i in call_stack_id..invocation_id_in_call_stack.len() {
if let Some(id) = invocation_id_in_call_stack[i] {
// We trust the caller to have the correct sub-invocation
// indices.
return self.sub_invocations[id]
.last_authorized_invocation_mut(invocation_id_in_call_stack, i + 1);
}
// Skip `None` invocations as they don't require authorization.
}
self
}
}
impl Default for AuthorizationManager {
fn default() -> Self {
Self::new_enforcing_without_authorizations(Budget::default())
}
}
impl AuthorizationManager {
// Creates a new enforcing `AuthorizationManager` from the given
// authorization entries.
// This should be created once per top-level contract invocation.
pub(crate) fn new_enforcing(
host: &Host,
auth_entries: Vec<ContractAuth>,
) -> Result<Self, HostError> {
let mut trackers = vec![];
for auth_entry in auth_entries {
trackers.push(AuthorizationTracker::from_authorization_entry(
host, auth_entry,
)?);
}
Ok(Self {
mode: AuthorizationMode::Enforcing,
call_stack: vec![],
budget: host.budget_cloned(),
trackers,
})
}
// Creates a new enforcing `AuthorizationManager` that doesn't allow any
// authorizations.
// This is useful as a safe default mode.
pub(crate) fn new_enforcing_without_authorizations(budget: Budget) -> Self {
Self {
mode: AuthorizationMode::Enforcing,
call_stack: vec![],
budget,
trackers: vec![],
}
}
// Creates a new recording `AuthorizationManager`.
// All the authorization requirements will be recorded and can then be
// retrieved using `get_recorded_auth_payloads`.
pub(crate) fn new_recording(budget: Budget) -> Self {
Self {
mode: AuthorizationMode::Recording(RecordingAuthInfo {
tracker_by_address_handle: Default::default(),
}),
call_stack: vec![],
budget,
trackers: vec![],
}
}
pub(crate) fn is_recording(&self) -> bool {
matches!(self.mode, AuthorizationMode::Recording(_))
}
// Require the `address` to have authorized the current contract invocation
// with provided args and within the current context (i.e. the current
// authorized call stack and for the current network).
// In the recording mode this stores the auth requirement instead of
// verifying it.
pub(crate) fn require_auth(
&mut self,
host: &Host,
address_obj_handle: u32,
address: ScAddress,
args: ScVec,
) -> Result<(), HostError> {
if let ScAddress::Contract(contract_addr) = &address {
// For now we give a blanket approval of the invoker contract to any
// calls it made, but never to the deeper calls. It's possible
// to eventually add a capability to pre-authorize arbitrary call
// stacks on behalf of the contract.
if let Ok(invoker_contract) = host.get_invoking_contract_internal() {
if &invoker_contract == contract_addr {
return Ok(());
}
}
}
if let Some(curr_invocation) = self.call_stack.last() {
match &mut self.mode {
AuthorizationMode::Enforcing => {
// Iterate all the trackers and try to find one that
// fullfills the authorization requirement.
for tracker in &mut self.trackers {
let address_matches = if let Some(addr) = &tracker.address {
addr == &address
} else {
// Lazily fill the address for the invoker trackers,
// so that it's possible to create the auth manager
// without knowing the invoker beforehand and also
// to not keep calling into `source_account` function.
let source_addr =
ScAddress::Account(host.source_account().ok_or_else(|| {
host.err_general("unexpected missing invoker in auth manager")
})?);
let source_matches = source_addr == address;
tracker.address = Some(source_addr);
source_matches
};
// If address doesn't match, just skip the tracker.
if address_matches {
match tracker.maybe_authorize_invocation(
host,
&curr_invocation.contract_id,
&curr_invocation.function_name,
&args,
) {
// If tracker doesn't have a matching invocation,
// just skip it (there could still be another
// tracker that matches it).
Ok(false) => continue,
// Found a matching authorization.
Ok(true) => return Ok(()),
// Found a matching authorization, but another
// requirement hasn't been fullfilled (for
// example, incorrect authentication or nonce).
Err(e) => return Err(e),
}
}
}
// No matching tracker found, hence the invocation isn't
// authorized.
Err(ScHostAuthErrorCode::NotAuthorized.into())
}
AuthorizationMode::Recording(recording_info) => {
if let Some(tracker_id) = recording_info
.tracker_by_address_handle
.get(&address_obj_handle)
{
let tracker = &mut self.trackers[*tracker_id];
// The recording invariant is that trackers are created
// with the first authorized invocation, which means
// that when their stack no longer has authorized
// invocation, then we've popped frames past its root
// and hence need to create a new tracker.
if !tracker.has_authorized_invocations_in_stack() {
recording_info
.tracker_by_address_handle
.remove(&address_obj_handle);
} else {
return self.trackers[*tracker_id].record_invocation(
host,
&curr_invocation.contract_id,
&curr_invocation.function_name,
args,
);
}
}
// If a tracker for the new tree doesn't exist yet, create
// it and initialize with the current invocation.
self.trackers.push(AuthorizationTracker::new_recording(
host,
address,
&curr_invocation.contract_id,
&curr_invocation.function_name,
args,
self.call_stack.len(),
)?);
recording_info
.tracker_by_address_handle
.insert(address_obj_handle, self.trackers.len() - 1);
Ok(())
}
}
} else {
// This would be a bug
Err(ScUnknownErrorCode::General.into())
}
}
// Returns a snapshot of `AuthorizationManager` to use for rollback.
pub(crate) fn snapshot(&self) -> AuthorizationManagerSnapshot {
let tracker_by_address_handle = match &self.mode {
AuthorizationMode::Enforcing => None,
AuthorizationMode::Recording(recording_info) => {
Some(recording_info.tracker_by_address_handle.clone())
}
};
AuthorizationManagerSnapshot {
trackers: self.trackers.clone(),
tracker_by_address_handle,
}
}
// Rolls back this `AuthorizationManager` to the snapshot state.
pub(crate) fn rollback(&mut self, snapshot: AuthorizationManagerSnapshot) {
self.trackers = snapshot.trackers;
if let Some(tracker_by_address_handle) = snapshot.tracker_by_address_handle {
match &mut self.mode {
AuthorizationMode::Recording(recording_info) => {
recording_info.tracker_by_address_handle = tracker_by_address_handle;
}
AuthorizationMode::Enforcing => (),
}
}
}
// Records a new call stack frame.
// This should be called for every `Host` `push_frame`.
pub(crate) fn push_frame(&mut self, host: &Host, frame: &Frame) -> Result<(), HostError> {
let (contract_id, function_name) = match frame {
#[cfg(feature = "vm")]
Frame::ContractVM(vm, fn_name, _) => {
(vm.contract_id.metered_clone(&self.budget)?, *fn_name)
}
// Just skip the host function stack frames for now.
// We could also make this included into the authorized stack to
// generalize all the host function invocations.
Frame::HostFunction(_) => return Ok(()),
Frame::Token(id, fn_name, _) => (id.metered_clone(&self.budget)?, *fn_name),
#[cfg(any(test, feature = "testutils"))]
Frame::TestContract(tc) => (tc.id.clone(), tc.func),
};
let Ok(ScVal::Symbol(function_name)) = host.from_host_val(function_name.to_raw()) else {
return Err(host.err_status(xdr::ScHostObjErrorCode::UnexpectedType))
};
self.call_stack.push(ContractInvocation {
contract_id,
function_name,
});
for tracker in &mut self.trackers {
tracker.push_frame();
}
Ok(())
}
// Pops a call stack frame.
// This should be called for every `Host` `pop_frame`.
pub(crate) fn pop_frame(&mut self) {
// Currently we don't push host function call frames, hence this may be
// called with empty stack. We trust the Host to keep things correct,
// i.e. that only host function frames are ignored this way.
// Eventually we may want to also authorize host fns via this, so this
// won't be needed.
if self.call_stack.is_empty() {
return;
}
self.call_stack.pop();
for tracker in &mut self.trackers {
tracker.pop_frame();
}
}
// Returns the recorded per-address authorization payloads that would cover the
// top-level contract function invocation in the enforcing mode.
// Should only be called in the recording mode.
pub(crate) fn get_recorded_auth_payloads(&self) -> Result<Vec<RecordedAuthPayload>, HostError> {
match &self.mode {
AuthorizationMode::Enforcing => Err(ScUnknownErrorCode::General.into()),
AuthorizationMode::Recording(_) => Ok(self
.trackers
.iter()
.map(|tracker| tracker.get_recorded_auth_payload())
.collect::<Result<Vec<RecordedAuthPayload>, HostError>>()?),
}
}
// For recording mode, emulates authentication that would normally happen in
// the enforcing mode.
// This helps to build a more realistic footprint and produce more correct
// meterting data for the recording mode.
// No-op in the enforcing mode.
pub(crate) fn maybe_emulate_authentication(&self, host: &Host) -> Result<(), HostError> {
match &self.mode {
AuthorizationMode::Enforcing => Ok(()),
AuthorizationMode::Recording(_) => {
for tracker in &self.trackers {
tracker.emulate_authentication(host)?;
}
Ok(())
}
}
}
// Returns a 'reset' instance of `AuthorizationManager` that has the same
// mode, but no data.
#[cfg(any(test, feature = "testutils"))]
pub(crate) fn reset(&mut self) {
*self = match self.mode {
AuthorizationMode::Enforcing => {
AuthorizationManager::new_enforcing_without_authorizations(self.budget.clone())
}
AuthorizationMode::Recording(_) => {
AuthorizationManager::new_recording(self.budget.clone())
}
}
}
// Returns the top-level authorizations that have been authenticated for the
// last contract invocation.
#[cfg(any(test, feature = "testutils"))]
pub(crate) fn get_authenticated_top_authorizations(
&self,
) -> Vec<(ScAddress, Hash, ScSymbol, ScVec)> {
self.trackers
.iter()
.filter(|t| t.authenticated)
.filter_map(|t| {
// Ignore authorizations without an address as they are implied,
// less useful as a test utility, and not succinctly capturable
// in the list of tuples. This is a tradeoff between offering up
// all authorizations vs the authorizations developers will
// mostly care about at the benefit of making this list easier
// to use.
t.address.as_ref().map(|a| {
AuthorizationManager::invocation_to_tuple(a, &t.root_authorized_invocation)
})
})
.collect()
}
// Returns all authorizations that have been authenticated for the
// last contract invocation.
#[cfg(any(test, feature = "testutils"))]
pub(crate) fn get_authenticated_authorizations(
&self,
) -> Vec<(ScAddress, Hash, ScSymbol, ScVec)> {
self.trackers
.iter()
.filter(|t| t.authenticated)
.filter_map(|t| {
// Ignore authorizations without an address as they are implied,
// less useful as a test utility, and not succinctly capturable
// in the list of tuples. This is a tradeoff between offering up
// all authorizations vs the authorizations developers will
// mostly care about at the benefit of making this list easier
// to use.
t.address.as_ref().map(|a| {
fn add_recursively_to_auths(
a: &ScAddress,
auths: &mut Vec<(ScAddress, Hash, ScSymbol, ScVec)>,
i: &AuthorizedInvocation,
) {
// Is exhausted indicates if the auth was in fact
// consumed by a call to require_auth.
if i.is_exhausted {
auths.push(AuthorizationManager::invocation_to_tuple(a, i));
}
for sub in &i.sub_invocations {
add_recursively_to_auths(a, auths, sub);
}
}
let mut auths = vec![];
add_recursively_to_auths(a, &mut auths, &t.root_authorized_invocation);
auths
})
})
.flatten()
.collect()
}
#[cfg(any(test, feature = "testutils"))]
// Builds a tuple containing the common details exposed from the
// AuthorizationManager about authenticated authorizations.
fn invocation_to_tuple(
address: &ScAddress,
authorized_invocation: &AuthorizedInvocation,
) -> (ScAddress, Hash, ScSymbol, ScVec) {
(
address.clone(),
authorized_invocation.contract_id.clone(),
authorized_invocation.function_name.clone(),
authorized_invocation.args.clone(),
)
}
}
impl AuthorizationTracker {
fn from_authorization_entry(host: &Host, auth_entry: ContractAuth) -> Result<Self, HostError> {
let is_invoker = auth_entry.address_with_nonce.is_none();
let (address, nonce) = if let Some(address_with_nonce) = auth_entry.address_with_nonce {
(
Some(address_with_nonce.address),
Some(address_with_nonce.nonce),
)
} else {
(None, None)
};
Ok(Self {
address,
root_authorized_invocation: AuthorizedInvocation::from_xdr(auth_entry.root_invocation)?,
signature_args: host.scvals_to_rawvals(auth_entry.signature_args.0.as_slice())?,
authenticated: false,
need_nonce: !is_invoker,
is_invoker,
nonce,
invocation_id_in_call_stack: vec![],
is_valid: true,
})
}
fn new_recording(
host: &Host,
address: ScAddress,
contract_id: &Hash,
function_name: &ScSymbol,
args: ScVec,
current_stack_len: usize,
) -> Result<Self, HostError> {
if current_stack_len == 0 {
// This would be a bug.
return Err(host.err_general("unexpected empty stack in recording auth"));
}
// If the invoker account is known, set it to `None`, so that the final
// recorded payload wouldn't contain the address. This makes it easier
// to use more optimal payload when only invoker auth is used.
let is_invoker = if let Some(source_acc) = host.source_account() {
ScAddress::Account(source_acc) == address
} else {
false
};
let nonce = if !is_invoker {
Some(host.read_and_consume_nonce(contract_id, &address)?)
} else {
None
};
// Create the stack of `None` leading to the current invocation to
// represent invocations that didn't need authorization on behalf of
// the tracked address.
let mut invocation_id_in_call_stack = vec![None; current_stack_len - 1];
// Add the id for the current(root) invocation.
invocation_id_in_call_stack.push(Some(0));
Ok(Self {
address: Some(address),
root_authorized_invocation: AuthorizedInvocation::new_recording(
contract_id,
function_name,
args,
),
invocation_id_in_call_stack,
signature_args: Default::default(),
is_valid: true,
authenticated: true,
need_nonce: false,
is_invoker,
nonce,
})
}
// Tries to find and enforce the provided invocation with this tracker and
// lazily performs authentication when needed.
// This is needed for the enforcing mode only.
// This assumes that the address matching is correctly performed before
// calling this.
// Returns true/false based on whether the invocation is found in the
// tracker. Returns error if invocation has been found, but the tracker
// itself is not valid (failed authentication or nonce check).
fn maybe_authorize_invocation(
&mut self,
host: &Host,
contract_id: &Hash,
function_name: &ScSymbol,
args: &ScVec,
) -> Result<bool, HostError> {
if !self.is_valid {
return Ok(false);
}
let frame_is_already_authorized = match self.invocation_id_in_call_stack.last() {
Some(Some(_)) => true,
_ => false,
};
if frame_is_already_authorized
|| !self.maybe_push_matching_invocation_frame(contract_id, function_name, args)
{
// The call isn't found in the currently tracked tree or is already
// authorized in it.
// That doesn't necessarily mean it's unauthorized (it can be
// authorized in a different tracker).
return Ok(false);
}
if !self.authenticated {
let authenticate_res = self
.authenticate(host)
.and_then(|_| self.verify_nonce(host));
if let Some(err) = authenticate_res.err() {
self.is_valid = false;
return Err(err);
}
self.authenticated = true;
}
Ok(true)
}
// Records the invocation in this tracker.
// This is needed for the recording mode only.
// This assumes that the address matching is correctly performed before
// calling this.
fn record_invocation(
&mut self,
host: &Host,
contract_id: &Hash,
function_name: &ScSymbol,
args: ScVec,
) -> Result<(), HostError> {
let frame_is_already_authorized = match self.invocation_id_in_call_stack.last() {
Some(Some(_)) => true,
_ => false,
};
if frame_is_already_authorized {
return Err(ScHostAuthErrorCode::DuplicateAuthorization.into());
}
if let Some(curr_invocation) = self.last_authorized_invocation_mut() {
curr_invocation
.sub_invocations
.push(AuthorizedInvocation::new_recording(
contract_id,
function_name,
args,
));
*self.invocation_id_in_call_stack.last_mut().unwrap() =
Some(curr_invocation.sub_invocations.len() - 1);
} else {
// This would be a bug
return Err(host.err_general("unexpected missing authorized invocation"));
}
Ok(())
}
// Build the authorization payload from the invocations recorded in this
// tracker.
fn get_recorded_auth_payload(&self) -> Result<RecordedAuthPayload, HostError> {
Ok(RecordedAuthPayload {
address: if self.is_invoker {
None
} else {
self.address.clone()
},
invocation: self.root_authorized_invocation.to_xdr_non_metered()?,
nonce: self.nonce,
})
}
// Checks if there is at least one authorized invocation in the current call
// stack.
fn has_authorized_invocations_in_stack(&self) -> bool {
self.invocation_id_in_call_stack.iter().any(|i| i.is_some())
}
fn invocation_to_xdr(&self, budget: &Budget) -> Result<xdr::AuthorizedInvocation, HostError> {
self.root_authorized_invocation.to_xdr(budget)
}
fn push_frame(&mut self) {
self.invocation_id_in_call_stack.push(None);
}
fn pop_frame(&mut self) {
self.invocation_id_in_call_stack.pop();
}
// Consumes nonce if the nonce check is still needed.
// Returns nonce if it has been consumed.
// Note, that for the invoker nonce is never needed.
fn maybe_consume_nonce(&mut self, host: &Host) -> Result<Option<u64>, HostError> {
if !self.need_nonce {
return Ok(None);
}
self.need_nonce = false;
if let Some(addr) = &self.address {
Ok(Some(host.read_and_consume_nonce(
&self.root_authorized_invocation.contract_id,
addr,
)?))
} else {
Ok(None)
}
}
// Walks a path in the tree defined by `invocation_id_in_call_stack` and
// returns the last visited authorized node.
fn last_authorized_invocation_mut(&mut self) -> Option<&mut AuthorizedInvocation> {
for i in 0..self.invocation_id_in_call_stack.len() {
if self.invocation_id_in_call_stack[i].is_some() {
return Some(
self.root_authorized_invocation
.last_authorized_invocation_mut(&self.invocation_id_in_call_stack, i + 1),
);
}
}
None
}
// Tries to match the provided invocation to the authorized sub-invocation
// of the current tree and push it to the call stack.
// Returns `true` if the match has been found.
fn maybe_push_matching_invocation_frame(
&mut self,
contract_id: &Hash,
function_name: &ScSymbol,
args: &ScVec,
) -> bool {
let mut frame_index = None;
if let Some(curr_invocation) = self.last_authorized_invocation_mut() {
for i in 0..curr_invocation.sub_invocations.len() {
let sub_invocation = &mut curr_invocation.sub_invocations[i];
if !sub_invocation.is_exhausted
&& &sub_invocation.contract_id == contract_id
&& &sub_invocation.function_name == function_name
&& &sub_invocation.args == args
{
frame_index = Some(i);
sub_invocation.is_exhausted = true;
break;
}
}
} else if !self.root_authorized_invocation.is_exhausted
&& &self.root_authorized_invocation.contract_id == contract_id
&& &self.root_authorized_invocation.function_name == function_name
&& &self.root_authorized_invocation.args == args
{
frame_index = Some(0);
self.root_authorized_invocation.is_exhausted = true;
}
if frame_index.is_some() {
*self.invocation_id_in_call_stack.last_mut().unwrap() = frame_index;
}
frame_index.is_some()
}
fn verify_nonce(&mut self, host: &Host) -> Result<(), HostError> {
let nonce_is_correct = if let Some(nonce) = self.maybe_consume_nonce(host)? {
if let Some(tracker_nonce) = self.nonce {
tracker_nonce == nonce
} else {
// If the nonce isn't set in the tracker, but is required, then
// it's incorrect.
false
}
} else {
// Nonce is either already checked or not needed in the first place.
true
};
if nonce_is_correct {
Ok(())
} else {
Err(ScHostAuthErrorCode::NonceError.into())
}
}
// Computes the payload that has to be signed in order to authenticate
// the authorized invocation tree corresponding to this tracker.
fn get_signature_payload(&self, host: &Host) -> Result<[u8; 32], HostError> {
let payload_preimage = HashIdPreimage::ContractAuth(HashIdPreimageContractAuth {
network_id: Hash(
host.with_ledger_info(|li| li.network_id.metered_clone(host.budget_ref()))?,
),
invocation: self.invocation_to_xdr(host.budget_ref())?,
nonce: self
.nonce
.ok_or_else(|| host.err_general("unexpected missing nonce"))?,
});
host.metered_hash_xdr(&payload_preimage)
}
fn authenticate(&self, host: &Host) -> Result<(), HostError> {
if self.is_invoker {
return Ok(());
}
if let Some(address) = &self.address {
// TODO: there should also be a mode where a dummy payload is used
// instead (for enforcing mode preflight).
let payload = self.get_signature_payload(host)?;
match address {
ScAddress::Account(acc) => {
check_account_authentication(host, acc, &payload, &self.signature_args)?;
}
ScAddress::Contract(acc_contract) => {
check_account_contract_auth(
host,
acc_contract,
&payload,
&self.signature_args,
&self.root_authorized_invocation,
)?;
}
}
Ok(())
} else {
Err(host.err_general("unexpected missing address to authenticate"))
}
}
// Emulates authentication for the recording mode.
fn emulate_authentication(&self, host: &Host) -> Result<(), HostError> {
if self.is_invoker {
return Ok(());
}
if let Some(address) = &self.address {
// Compute the real payload for the sake of metering, but don't use it.
let _payload = self.get_signature_payload(host)?;
match address {
ScAddress::Account(acc) => {
let _account = host.load_account(acc.clone())?;
}
// Skip custom accounts for now - emulating authentication for
// them requires a dummy signature.
ScAddress::Contract(_) => (),
}
Ok(())
} else {
Err(host.err_general("unexpected missing address to emulate authentication"))
}
}
}
impl Host {
#[cfg(test)]
pub(crate) fn read_nonce(
&self,
contract_id: &Hash,
address: &ScAddress,
) -> Result<u64, HostError> {
let nonce_key_scval = ScVal::LedgerKeyNonce(ScNonceKey {
nonce_address: address.metered_clone(self.budget_ref())?,
});
let nonce_key = self.storage_key_for_contract(
contract_id.metered_clone(self.budget_ref())?,
nonce_key_scval,
);
let curr_nonce: u64 =
if self.with_mut_storage(|storage| storage.has(&nonce_key, self.budget_ref()))? {
let entry =
self.with_mut_storage(|storage| storage.get(&nonce_key, self.budget_ref()))?;
match &entry.data {
LedgerEntryData::ContractData(ContractDataEntry { val, .. }) => match val {
ScVal::U64(val) => *val,
_ => {
return Err(self.err_general("unexpected nonce entry type"));
}
},
_ => return Err(self.err_general("unexpected missing nonce entry")),
}
} else {
0
};
Ok(curr_nonce)
}
fn read_and_consume_nonce(
&self,
contract_id: &Hash,
address: &ScAddress,
) -> Result<u64, HostError> {
let nonce_key_scval = ScVal::LedgerKeyNonce(ScNonceKey {
nonce_address: address.metered_clone(self.budget_ref())?,
});
let nonce_key = self.storage_key_for_contract(
contract_id.metered_clone(self.budget_ref())?,
nonce_key_scval.clone(),
);
let curr_nonce: u64 =
if self.with_mut_storage(|storage| storage.has(&nonce_key, self.budget_ref()))? {
let entry =
self.with_mut_storage(|storage| storage.get(&nonce_key, self.budget_ref()))?;
match &entry.data {
LedgerEntryData::ContractData(ContractDataEntry { val, .. }) => match val {
ScVal::U64(val) => *val,
_ => {
return Err(self.err_general("unexpected nonce entry type"));
}
},
_ => return Err(self.err_general("unexpected missing nonce entry")),
}
} else {
0
};
let data = LedgerEntryData::ContractData(ContractDataEntry {
contract_id: contract_id.metered_clone(self.budget_ref())?,
key: nonce_key_scval,
val: ScVal::U64(curr_nonce + 1),
});
let entry = LedgerEntry {
last_modified_ledger_seq: 0,
data,
ext: LedgerEntryExt::V0,
};
self.with_mut_storage(|storage| {
storage.put(&nonce_key, &Rc::new(entry), self.budget_ref())
})?;
Ok(curr_nonce)
}
}