LogoLogo
SupportGithubSign InGet Access
  • Introduction
  • GETTING STARTED
    • SDK Quick Start
    • API Quick Start
  • Guides
    • Web
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Web authentication methods
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Configure a custom subdomain
      • Eject a wallet
      • Using the EIP-1193 Provider
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • iOS
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Manage ERC20 tokens
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
          • Passkey + Enclave Storage
        • Recover a wallet
      • Troubleshooting Tips
      • Feature Flags
    • Android
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • React Native
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • Enclave MPC API
      • Create a client
      • Create a wallet
      • Send tokens
      • Sign Ethereum transactions
      • Sign Solana transactions
      • Sign Tron transactions
      • Sign Stellar Transaction
      • Concurrent Transactions
      • Back up a wallet
      • Eject a wallet
  • Reference
    • iOS
      • createWallet
      • backupWallet
      • recoverWallet
      • ejectPrivateKeys
      • registerBackupMethod
      • setGDriveConfiguration
      • setPasskeyConfiguration
      • setPasskeyAuthenticationAnchor
      • setPassword
      • availableRecoveryMethods
      • doesWalletExist
      • isWalletBackedUp
      • isWalletOnDevice
      • isWalletRecoverable
      • getBalances
      • getAssets
      • getNftAssets
      • getTransactions
      • sendSol
      • evaluateTransaction
      • buildEip155Transaction
      • buildSolanaTransaction
      • getWalletCapabilities
    • Android
      • Reference Documentation
    • React Native
      • @portal-hq/core
      • Storage adapters
        • Cloud storage
          • @portal-hq/gdrive-storage
          • @portal-hq/icloud-storage
        • Mobile storage
          • @portal-hq/keychain
          • @portal-hq/mobile-key-values
    • Enclave MPC API
      • V1 endpoints
    • Client API
      • V3 endpoints
      • V1 endpoints
    • Custodian API
      • V3 endpoints
      • V1 endpoints
    • Swaps API
      • V3 endpoints
      • V1 endpoints
  • Resources
    • Flutter
      • iOS
      • Android
    • Error codes
      • Overview
      • MPC errors
      • Network errors
      • General errors
      • Encryption errors
      • Portal Connect errors
    • Portal's MPC architecture
    • Authentication and API Keys
    • Self-Managed Backups
    • Alert Webhooks
    • Wallet lifecycle
    • Backup options
      • Password/PIN
      • GDrive
      • iCloud
      • Passkey + Enclave
    • WalletConnect metadata
    • Advanced security scanning
    • Account abstraction
    • Security firewall
    • Eject
    • Security
    • Blockchain support
    • Chain ID formatting
    • Testnet faucets
    • Going to Production
    • Rate Limits
    • Multi-backup migration guide
    • Multi-wallet migration guides
      • Migrating from Android SDK v3.x.x to v4.x.x
      • Migrating from iOS SDK v3.0.x to v3.2.x
  • Support
    • Changelog
      • Android
      • iOS
      • React Native
      • Web
      • Past Releases
        • 2024 Releases
        • 2023 Releases
    • Celo Hackathon Hub
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. Reference
  2. iOS

setPassword

Sets the password used for the Password backup method. This method configures the password that will be used to encrypt and decrypt wallet backups using password-based key derivation.

Function Signature

public func setPassword(
    _ value: String
) throws

Parameters

  • value: The password string used to generate a key for backup encryption/decryption via password-based key derivation. This should be a secure password that the user can reliably remember or safely store.

Throws

  • MpcError.backupMethodNotRegistered if the Password backup method has not been registered using registerBackupMethod

Notes

  • Must be called before using the .Password backup method for wallet backup or recovery operations

  • The password should be securely stored or provided by the user when needed

  • Should be used in conjunction with registering the Password backup method

Example Usage

// Basic usage
do {
    try portal.setPassword("mySecurePassword123!")
} catch {
    print("Error setting password: \(error)")
}

// Complete setup with password backup
do {
    // First register the password storage method
    let passwordStorage = PasswordStorage()
    portal.registerBackupMethod(.Password, withStorage: passwordStorage)
    
    // Set the password
    try portal.setPassword("mySecurePassword123!")
    
    // Now you can use password-based backup
    let backup = try await portal.backupWallet(.Password) { status in
        switch status.status {
        case .readingShare:
            print("Reading share...")
        case .encryptingShare:
            print("Encrypting with password...")
        case .storingShare:
            print("Storing encrypted backup...")
        case .done:
            print("Backup complete!")
        default:
            break
        }
    }
    
    // Complete the backup process
    try await backup.storageCallback()
} catch {
    print("Error in password backup process: \(error)")
}

// Example with password recovery
do {
    // Set up password for recovery
    try portal.setPassword("mySecurePassword123!")
    
    // Recover wallet using password
    let recovered = try await portal.recoverWallet(
        .Password,
        withCipherText: backupCipherText
    ) { status in
        print("Recovery status: \(status)")
    }
    
    print("Recovered wallet with address: \(recovered.ethereum)")
} catch {
    print("Error in password recovery process: \(error)")
}

Security Best Practices

  1. Use strong passwords that meet these criteria:

    • Minimum length of 12 characters

    • Mix of uppercase and lowercase letters

    • Include numbers and special characters

    • Avoid common patterns or personal information

  2. Password Storage:

    • Never store the password in plain text

    • Consider using the iOS Keychain for secure storage

    • Implement appropriate password recovery mechanisms

  3. User Experience:

    • Validate password strength during input

    • Provide clear feedback on password requirements

    • Consider implementing biometric authentication for accessing stored passwords

Implementation Flow

  1. Register the Password backup method

  2. Set the password using this method

  3. Use the password for backup or recovery operations

  4. Implement secure password storage and recovery

Related Documentation

For more information about password-based backup and security, see:

PrevioussetPasskeyAuthenticationAnchorNextavailableRecoveryMethods

Last updated 3 months ago

Was this helpful?

Password/Pin Backup