Documentation Index
Fetch the complete documentation index at: https://mintlify.com/stellar/rs-soroban-sdk/llms.txt
Use this file to discover all available pages before exploring further.
The auth module contains types for building custom account contracts that implement authorization logic.
Overview
Custom account contracts implement the __check_auth special function to handle authorization for their addresses. When Address::require_auth is called for a custom account address, the account contract’s __check_auth implementation is invoked to verify the authorization.
Types
Context
Represents the context of a single authorized call performed by an address.
pub enum Context {
Contract(ContractContext),
CreateContractHostFn(CreateContractHostFnContext),
CreateContractWithCtorHostFn(CreateContractWithConstructorHostFnContext),
}
Context values corresponding to all calls that need authorization.
ContractContext
Authorization context for a single contract call.
pub struct ContractContext {
pub contract: Address,
pub fn_name: Symbol,
pub args: Vec<Val>,
}
require_auth_for_args call with:
contract - The contract address being calledfn_name - The function name being invokedargs - The arguments passed to the function
CreateContractHostFnContext
Authorization context for creating a contract without constructor arguments.
pub struct CreateContractHostFnContext {
pub executable: ContractExecutable,
pub salt: BytesN<32>,
}
CreateContractWithConstructorHostFnContext
Authorization context for creating a contract with constructor arguments.
pub struct CreateContractWithConstructorHostFnContext {
pub executable: ContractExecutable,
pub salt: BytesN<32>,
pub constructor_args: Vec<Val>,
}
ContractExecutable
Defines the executable used when creating a contract.
pub enum ContractExecutable {
Wasm(BytesN<32>),
}
InvokerContractAuthEntry
A node in the tree of authorizations performed by the current contract as invoker.
pub enum InvokerContractAuthEntry {
Contract(SubContractInvocation),
CreateContractHostFn(CreateContractHostFnContext),
CreateContractWithCtorHostFn(CreateContractWithConstructorHostFnContext),
}
authorize_as_current_contract to specify authorization for sub-invocations.
SubContractInvocation
Value of a contract node in the InvokerContractAuthEntry tree.
pub struct SubContractInvocation {
pub context: ContractContext,
pub sub_invocations: Vec<InvokerContractAuthEntry>,
}
Traits
CustomAccountInterface
Interface for implementing custom account authorization.
pub trait CustomAccountInterface {
type Signature;
type Error: Into<Error>;
fn __check_auth(
env: Env,
signature_payload: Hash<32>,
signatures: Self::Signature,
auth_contexts: Vec<Context>,
) -> Result<(), Self::Error>;
}
signature_payload - Hash of the data that should be signedsignatures - Custom signature data provided by the invokerauth_contexts - List of authorization contexts to verify
Returns: Ok(()) if authorization succeeds, or an error otherwise.
Example
use soroban_sdk::{contract, contractimpl, contracttype, Env, BytesN, Vec};
use soroban_sdk::auth::{Context, CustomAccountInterface};
use soroban_sdk::crypto::Hash;
#[contracttype]
pub enum Signature {
Ed25519(BytesN<64>),
}
#[contract]
pub struct CustomAccount;
#[contractimpl]
impl CustomAccountInterface for CustomAccount {
type Signature = Signature;
type Error = soroban_sdk::Error;
fn __check_auth(
env: Env,
signature_payload: Hash<32>,
signature: Signature,
auth_contexts: Vec<Context>,
) -> Result<(), Self::Error> {
// Verify signature against signature_payload
// Validate auth_contexts
Ok(())
}
}
See Also
- Address - For
require_auth and authorization methods
- crypto - For signature verification functions