TOTP Swift SDK

Integrate secure Time-based One-Time Password (TOTP) capabilities into your iOS applications. Manage encrypted tenant enrollments, customizable validation algorithms, and hardware-backed Keychain storage.

The Fyno TOTP SDK for iOS provides secure Time-based One-Time Password (TOTP) generation and tenant management. It supports tenant enrollment, secure secret storage using the iOS Keychain, configurable TOTP parameters, and OTP generation compliant with RFC 6238.

Module Name: FynoTOTP
Minimum iOS Version: iOS 13
Target iOS Version: iOS 16+
Language: Swift

Installation
Core Components
API Reference
Usage Examples
Data Models
Error Handling
Security Considerations

Installation

CocoaPods

Add the dependency to your Podfile:

pod 'FynoTOTP'

Then run:

pod install

Core Components

FynoTOTP Class

The main entry point for all SDK operations.

Responsibilities:

SDK initialization
Tenant registration and revocation
Secure secret storage using Keychain
TOTP generation

Initializer:

let fynoTotp = FynoTOTP()

API Reference

initFynoConfig

Initializes the SDK with workspace and user identifiers.

func initFynoConfig(
    wsid: String,
    distinctId: String,
    completion: @escaping (Result<Void, Error>) -> Void
)

registerTenant

Registers a tenant and securely stores the TOTP secret.

func registerTenant(
    tenantId: String,
    tenantLabel: String,
    totpToken: String,
    completion: @escaping (Result<Void, Error>) -> Void
)

setConfig

Sets the TOTP configuration for a tenant.

func setConfig(
    tenantId: String,
    config: TotpConfig,
    completion: @escaping (Result<Void, Error>) -> Void
)

getTotp

Generates and retrieves the current TOTP code.

func getTotp(
    tenantId: String,
    completion: @escaping (Result<String?, Error>) -> Void
)

deleteTenantData

Deletes all tenant data and the stored secret.

func deleteTenantData(tenantId: String)

fetchActiveTenants

Fetches the active tenants.
 
func fetchActiveTenants(
    completion: @escaping (Result<[ActiveTenant], Error>) -> Void
)

Data Models

TotpConfig

struct TotpConfig: Codable {
    let tenant_name: String
    let digits: Int
    let algorithm: String
    let period: Int
}

Error Handling

FynoError

enum FynoError: Error {
    case invalidSecret
    case invalidSecretEncoding
    case unsupportedAlgorithm
    case hashingFailed
    case base64DecodeFailed
    case secretDecodeFailed
}