iOS

Supported Platforms

• iOS 15+
• macOS 12+

Quickstart

Install SDK

The Evervault iOS SDK can be installed using the Swift Package Manager.

1. Open your Xcode project.
2. Navigate to File > Swift Packages > Add Package Dependency.
3. Enter the repository URL for the Evervault iOS SDK: https://github.com/evervault/evervault-ios.git.
4. Choose the latest available version or specify a version rule.
5. Click Next and follow the instructions to integrate the package into your project.

Initialize SDK

Now, let's initialize the SDK using our App and Team ID. If you don't have one yet, you can get one by creating an App in the Evervault Dashboard.

1import EvervaultCore
2
3Evervault.shared.configure(teamId: "<TEAM_ID>", appId: "<APP_ID>")

If you need multiple instances of the Evervault SDK you can use the initializer as follows:

1import EvervaultCore
2
3let evervault = Evervault.init(teamId: "<TEAM_ID>", appId: "<APP_ID>")

Encrypting Data

Once the SDK is configured, you can use the encrypt method to encrypt your sensitive data. The encrypt method accepts various data types, including Boolean, Numerics, Strings, Arrays, Dictionaries, and Data.

Here's an example of encrypting a password:

1let encryptedPassword = Evervault.shared.encrypt("Super Secret Password")

Or using a dedicated instance:

1let encryptedPassword = evervault.encrypt("Super Secret Password")

The encrypt method returns an Any type, so you will need to safely cast the result based on the data type you provided. For Boolean, Numerics, and Strings, the encrypted data is returned as a String. For Arrays and Dictionaries, the encrypted data maintains the same structure but is encrypted. For Data, the encrypted data is returned as encrypted Data, which can be useful for encrypting files.

Decrypting Data

Decrypts data previously encrypted with the encrypt() function or through Relay.

The decrypt() method allows you to decrypt previously encrypted data using a token.

The token is a time bound token for decrypting data. The token can be generated using our backend SDKs or through our REST API.

The payload must be the same payload that was used to create the token and expires in a maximum of 10 minutes depending on the expiry set when creating the token.

1let encryptedPassword = Evervault.shared.encrypt("Super Secret Password")
2let decrypted: String = Evervault.shared.decrypt('<token generated by your backend application>', encryptedPassword)

Inputs

The Evervault iOS SDK also includes the EvervaultInputs module, which provides a SwiftUI view called PaymentCardInput. This view is designed for capturing credit card information and automatically encrypts the credit card number and CVC without exposing the unencrypted data. The PaymentCardInput view can be customized to fit your application's design.

To use PaymentCardInput, make sure you have imported the EvervaultInputs module in your file, and then simply add the view to your SwiftUI hierarchy:

1import EvervaultInputs
2
3struct ContentView: View {
4
5    @State private var cardData = PaymentCardData()
6
7    var body: some View {
8        VStack {
9            PaymentCardInput(cardData: $cardData)
10
11            // Data captured:
12            Text("Encrypted credit card number: \(cardData.card.number)")
13        }
14    }
15}

Fields can be optionally displayed by passing in the enabledFields struct. For example if you with to only render the Card Number field use the following code.

1import EvervaultInputs
2
3struct ContentView: View {
4
5    private var enabledFields = EnabledFields(isCardNumberEnabled: true, isExpiryEnabled: false, isCVCEnabled: false)
6
7    @State private var cardData = PaymentCardData()
8
9    var body: some View {
10        VStack {
11            PaymentCardInput(cardData: $cardData, fields: enabledFields)
12
13            // Data captured:
14            Text("Encrypted credit card number: \(cardData.card.number)")
15        }
16    }
17}

The encrypted credit card number and CVC are captured in the PaymentCardData Binding, as well as the expiry month and year and validation fields.

Styling

Internally, the PaymentCardInput view uses SwiftUI TextFields. These can be customized using SwiftUI modifiers like any other TextFields in your application:

1PaymentCardInput(cardData: $cardData)
2        .font(.footnote)
3        .foregroundColor(.blue)

To provide more customization options, the PaymentCardInput can be styled using a PaymentCardInputStyle. There are two build-in styles:

• InlinePaymentCardInputView (the default style) - puts the credit card number, expiry and cvc fields all on a single row.

To explicitly use this style:

1PaymentCardInput(cardData: $cardData)
2        .paymentCardInputStyle(.inline)

• RowsPaymentCardInputStyle - puts the credit card number on a single row. Below it, places the expiry and cvc fields next to each other.

To use this style:

1PaymentCardInput(cardData: $cardData)
2        .paymentCardInputStyle(.rows)

If these two styles do not match your use case, you can create your own style:

1struct CustomPaymentCardInputStyle: PaymentCardInputStyle {
2
3    func makeBody(configuration: Configuration) -> some View {
4        VStack(alignment: .center) {
5            configuration.cardImage
6
7            Text("CC Number").font(.title3)
8            configuration.cardNumberField
9
10            Divider()
11
12            Text("Expiry").font(.title3)
13            configuration.expiryField
14
15            Divider()
16
17            Text("CVC").font(.title3)
18            configuration.cvcField
19        }
20    }
21}

1PaymentCardInput(cardData: $cardData)
2        .paymentCardInputStyle(CustomPaymentCardInputStyle())

Attest Enclaves

The Evervault iOS SDK includes the ability to attest connections to Enclaves.

To attest your Enclave, you need to provide the expected PCRs to an Enclave session.

1import EvervaultCore
2import EvervaultEnclaves
3
4//Note: Make sure app uuid is hyphenated (eg: app-123456).
5let url = URL(string: "https://<ENCLAVE_NAME>.<APP_UUID>.enclave.evervault.com")
6let enclaveSession = Evervault.enclaveSession(
7  enclaveAttestationData: EnclaveAttestationData(
8    enclaveName: "<ENCLAVE_NAME>",
9    appUuid: "<APP_UUID>",
10    pcrs: PCRs(
11      pcr0: "<PCR0>",
12      pcr1: "<PCR1>",
13      pcr2: "<PCR2>",
14      pcr8: "<PCR8>",
15    )
16  )
17)
18
19do {
20  let response = try await enclaveSession.data(from: url)
21  // ...
22} catch {
23  // ...
24}

Apple Pay®

The Evervault iOS SDK provides support for Apple Pay on iOS, enabling secure handling of card data during mobile transaction flows. When a customer taps the Apple Pay button in your app, our SDK will give you the Apple Pay card token (DPAN) from the user's device.

Instead of using Apple's default encryption, the SDK extracts the customer's card details, including the card token and "cryptogram", and returns them in an Evervault-encrypted payload. This allows you to securely access sensitive values while ensuring they remain protected through Evervault's encryption infrastructure.

The encrypted payload can then be safely passed to any downstream system or payment processor for transaction authorization using our proxy, Evervault Relay.

In Sandbox apps, the encrypted network token maps to a brand-specific test card based on the card the customer selects in their Apple Wallet.

Prerequisites

• You must have an individual or organisational Apple Developer account.

• All users of Apple Pay agree to adhere to the Apple Pay Terms and Conditions.

Register for an Apple Merchant ID

Before you can use Apple Pay for iOS with Evervault you need to obtain an Apple Merchant ID by registering for a new identifier on the Apple Developer portal. Fill out the description and identifier. We recommend you use the name of your app as the identifier e.g. merchant.com.<YOUR_APPS_NAME>

Create a new Apple Pay Payment Processing Certificate

Apple Pay needs to encrypt payment data such as card details. You will need a payment processing certificate for your app to allow Apple Pay to encrypt those details within your app.

In the Evervault dashboard, click the Payments tab at the top of the page. Then, on the left-hand side of the page click Apple Pay and at the bottom of the page under Certificates, click Add certificate. Follow the on screen instructions.

As part of this flow, Evervault will provide you with a certificate signing request that you must download.

Then, in a new tab, in the Apple Developer portal, under Certificates, create an Apple Pay Payment Processing Certificate, select the Merchant ID that you created in the previous step and click Continue. Under the Apple Pay Payment Processing Certificate section, click Create Certificate and upload the certificate signing request you downloaded from the Evervault dashboard.

Download the Apple certificate you just created and go back to the Evervault dashboard and in the certificate set up dialog, upload the certificate you just downloaded from Apple.

Setting up Xcode

Once you have created your merchant identifier and payment processing certificate, you need to add the Apple Pay capability to your app in Xcode.

Open your project settings, click the Signing & Capabilities tab, and add the Apple Pay capability. You might be prompted to sign in to your developer account. Select the merchant ID you created earlier, and now your app is ready to accept Apple Pay.

Create a Transaction

Next you will need to create a transaction to describe the payment you want to process. You will need to provide the country, currency, and line items for the transaction. The last item is the total for the transaction.

If the transaction is not constructed correctly e.g country or currency fields aren't correct or there are no summary items then an EvervaultError.InvalidTransaction error will be thrown.

Please refer to Apple's documentation on requirements for country and currency and amount fields.

1import EvervaultPayment
2
3let oneOff = try! OneOffPaymentTransaction(
4  country: "IE",
5  currency: "EUR",
6  paymentSummaryItems: [
7    SummaryItem(label: "Mens Shirt", amount: Amount("30.00")),
8    SummaryItem(label: "Socks", amount: Amount("5.00")),
9    SummaryItem(label: "Total", amount: Amount("35.00"))
10  ]
11)
12
13let transaction = EvervaultPayment.Transaction.oneOffPayment(oneOff)

OneOffPaymentTransaction and RecurringPaymentTransaction also accept a requestPayerDetails parameter to request billing contact fields — such as the payer's name, email, phone, or postal address — using PassKit's own PKContactField values:

1import EvervaultPayment
2
3let oneOff = try! OneOffPaymentTransaction(
4  country: "IE",
5  currency: "EUR",
6  paymentSummaryItems: [
7    SummaryItem(label: "Mens Shirt", amount: Amount("30.00")),
8    SummaryItem(label: "Socks", amount: Amount("5.00")),
9    SummaryItem(label: "Total", amount: Amount("35.00"))
10  ],
11  requestPayerDetails: [.name, .phoneticName, .phoneNumber, .emailAddress, .postalAddress]
12)
13
14let transaction = EvervaultPayment.Transaction.oneOffPayment(oneOff)

Check if Apple Pay is supported

Before displaying Apple Pay as a payment option, use the availability(supportedNetworks:) method to check whether the device supports Apple Pay, and whether the customer has a card in their wallet. It returns one of three states, matching the web SDK:

• available: Apple Pay is supported and the customer has a usable card.
• unavailable: Apple Pay is supported, but the customer hasn't added a card for the networks you accept.
• unsupported: Apple Pay isn't supported on this device.

1let availability = EvervaultPaymentViewRepresentable.availability(supportedNetworks: [.visa, .masterCard, .amex])

Use unsupported to hide the Apple Pay button entirely. Use unavailable to show a Set Up Apple Pay button instead of a regular buy button (see Customise the Apple Pay button for more details).

1let isAvailable = EvervaultPaymentViewRepresentable.isAvailable()

Render the Apple Pay button

Next you can render the Apple Pay button. When you do this, you will need to pass in your Evervault App ID, your Apple Merchant Identifier, the transaction object, the card networks you support, and a callback closure:

• authorizedResponse: Whenever the user successfully authorizes the payment, the decrypted ApplePayResponse (containing token, card info, cryptogram, etc.) will be written into your @State variable. You can react to that state change however you like — navigate onward, show a confirmation screen, or send it off to your own backend to be sent via an Evervault Relay to your PSP. Refer to this section for the structure of the response.
• onResult: Use this callback to reset UI state or advance your checkout flow after the sheet closes with a definite outcome (either success or failure). Failures can happen when Apple Pay is unavailable, the transaction is invalid, presentation fails, or if Evervault can't decrypt the payment details. The callback returns a Result<Void, EvervaultError>. The EvervaultError includes a localizedDescription you can display in an alert, log for diagnostics, or present however appropriate. onResult doesn't fire if the customer cancels.
• onCancel: Use this modifier to detect when the customer dismisses the sheet without authorizing a payment (e.g., taps Cancel). This is distinct from the success or failure provided by onResult.

1struct ContentView: View {
2  @State private var applePayResponse: ApplePayResponse? = nil
3  let transaction = buildTransaction()
4
5  var body: some View {
6    VStack(spacing: 20) {
7      EvervaultPaymentViewRepresentable(
8        appId: "YOUR_EVERVAULT_APP_ID",
9        appleMerchantId: "YOUR_APPLE_MERCHANT_IDENTIFIER",
10        transaction: transaction,
11        supportedNetworks: [.visa, .masterCard, .amex],
12        authorizedResponse: $applePayResponse) { result in
13            switch result {
14            case .success(_):
15                print("Payment sheet dismissed with success")
16                if (applePayResponse != nil) {
17                    // Send to PSP via Relay on your backend
18                }
19                break
20            case let .failure(error):
21                print("Payment error: \(error.localizedDescription)")
22                break
23            }
24        }
25        .onCancel {
26            print("Payment sheet cancelled")
27        }
28    }
29  }
30}

Processing the Payment

If the payment is handled successfully, the Evervault encrypted payment method is available in $applePayResponse (in the example above). The authorizedResponse is an ApplePayResponse object containing the payment method details encrypted with the Evervault public key. You can send this encrypted payment method to your server and use Evervault Relay to decrypt the payment details when you send them to your PSP.

The ApplePayResponse object represented as JSON contains the following fields:

1{
2  "networkToken": {
3    "number": "ev:Tk9D:hY5KJanIPOHBoI8S:AsnnjRl0FDe2zEddBAQG/eI2vN+b...:$",
4    "expiry": {
5      "month": "12",
6      "year": "31"
7    },
8    "tokenServiceProvider": "Apple"
9  },
10  "card": {
11    "brand": "visa",
12    "funding": "debit",
13    "segment": "consumer",
14    "country": "ie",
15    "currency": "eur",
16    "issuer": "Revolut Bank Uab"
17  },
18  "cryptogram": "ev:Tk9D:vUVeybXqrA9Ds4rZ...=:$",
19  // The ECI value is optional with Apple Pay.
20  // Learn more here: https://developer.apple.com/documentation/passkit/payment-token-format-reference#Detailed-payment-data-keys-3D-Secure
21  "eci": "5",
22  "paymentDataType": "3DSecure",
23  "deviceManufacturerIdentifier": "string",
24  "transactionType": "oneOff",
25  "transactionId": "5ee9e294a2e79032ca7529b2050c2a878187c54a54f07559cff8281fb9b4716c",
26
27  // Only present if you requested the corresponding contact fields on the transaction
28  "billingContact": {
29    "givenName": "John",
30    "familyName": "Doe",
31    "phoneticGivenName": null,
32    "phoneticFamilyName": null,
33    "emailAddress": "john.doe@example.com",
34    "phoneNumber": "1234567890",
35    "postalAddress": {
36      "street": "123 Main St",
37      "city": "City",
38      "state": "State",
39      "postalCode": "12345",
40      "country": "Country",
41      "isoCountryCode": "XX"
42    }
43  },
44  "shippingContact": {
45    "givenName": "John",
46    "familyName": "Doe",
47    "phoneticGivenName": null,
48    "phoneticFamilyName": null,
49    "emailAddress": "john.doe@example.com",
50    "phoneNumber": "1234567890"
51  }
52}

transactionType indicates the transaction category (oneOff, recurring, or disbursement) based on how you created the transaction. transactionId is Apple's identifier for the token, and comes from the PKPaymentToken header. Some payment gateways require it to be passed through, though it isn't used to authorize the transaction itself. billingContact and shippingContact are only populated when the transaction requested those contact fields. phoneticFamilyName and phoneticGivenName are populated when the customer's Apple Wallet contact card includes a phonetic reading of their name (common in locales like Japan). If there's no phonetic reading, then these two values are null.

Complete example

Below is a complete example of Evervault Apple Pay in action:

1import SwiftUI
2import EvervaultPayment
3
4func buildTransaction() -> EvervaultPayment.Transaction {
5  let oneOff = try! OneOffPaymentTransaction(
6    country: "IE",
7    currency: "EUR",
8    paymentSummaryItems: [
9      SummaryItem(label: "Mens Shirt", amount: Amount("30.00")),
10      SummaryItem(label: "Socks", amount: Amount("5.00")),
11      SummaryItem(label: "Total", amount: Amount("35.00"))
12    ]
13  )
14  return Transaction.oneOffPayment(oneOff)
15}
16
17struct ContentView: View {
18  @State private var applePayResponse: ApplePayResponse? = nil
19  let transaction = buildTransaction()
20  let supportedNetworks: [Network] = [.visa, .masterCard, .amex]
21
22  var body: some View {
23    let availability = EvervaultPaymentViewRepresentable.availability(supportedNetworks: supportedNetworks)
24
25    VStack(spacing: 20) {
26      if availability != .unsupported {
27        // Apple Pay is supported — show the setup button if there's no card yet
28        EvervaultPaymentViewRepresentable(
29          appId: "YOUR_EVERVAULT_APP_ID",
30          appleMerchantId: "YOUR_APPLE_MERCHANT_IDENTIFIER",
31          transaction: transaction,
32          supportedNetworks: supportedNetworks,
33          buttonStyle: .whiteOutline,
34          buttonType: availability == .unavailable ? .setUp : .checkout,
35          authorizedResponse: $applePayResponse) { result in
36              switch result {
37              case .success(_):
38                  print("Payment sheet dismissed with success")
39                  if (applePayResponse != nil) {
40                    // Send to PSP via Relay on your backend
41                  }
42                  break
43              case let .failure(error):
44                  print("Payment error: \(error.localizedDescription)")
45                  break
46              }
47          }
48          .onCancel {
49              print("Payment sheet cancelled")
50          }
51      } else {
52        Text("Not available")
53      }
54    }
55  }
56}
57
58#Preview {
59    ContentView()
60}

Customise the Apple Pay button

When initialising the EvervaultPaymentViewRepresentable you can pass two optional parameters — buttonType and buttonStyle.

Please refer to the Apple PassKit documentation on what preset button styles and types are available.

1EvervaultPaymentViewRepresentable(
2  // other fields...
3  buttonStyle: .whiteOutline,
4  buttonType: .checkout,
5)

If availability(supportedNetworks:) returns unavailable, Apple recommends showing the Set Up Apple Pay button instead of the default buy button. This takes the customer through the flow for adding a card rather than opening a payment sheet, which would fail.

1EvervaultPaymentViewRepresentable(
2  // other fields...
3  buttonStyle: .whiteOutline,
4  buttonType: availability == .unavailable ? .setUp : .checkout,
5)

Error Handling

All errors from creating the Transaction object and the errors surfaced in the onResult callback on the EvervaultPaymentViewRepresentable can be cast to EvervaultError:

• InvalidTransactionError - This error is thrown when there is an with the transaction. As a guideline to help prevent encountering this error:
  • country: The merchant's two-letter ISO 3166 country code.
  • currency: The three-letter ISO 4217 currency code that determines the currency the payment request uses.
  • amount: The format of this value depends on the currency. It follows ISO 4217 and depends on the minor unit of the currency e.g the number of decimal points forUSD is 2, so the amount must be formatted as "50.00". This error will be thrown if you try to format the amount as "50.0". As another example, JPY has no minor unit so the amount must be formatted as "1000".
• ApplePayUnavailableError - This error is thrown when Apple Pay is not available on the device
• ApplePayPaymentSheetError - This error is thrown when an underlying error with the Apple Pay payment sheet occurs.
• InternalError - This error is thrown when something goes wrong during the handling of the payment data. An underlying reason will be provided in this case.

Full example

A complete working example is included in the Evervault iOS package, located in the EvervaultIOSApp directory.

Running the Sample App

To run the sample app:

1. Open the EvervaultIOSApp.xcodeproj file in Xcode.
2. Configure your Team ID and App ID in EvervaultIOSAppApp.swift or add EV_TEAM_UUID and EV_APP_UUID Environment Variables the Run Scheme.
3. Select a simulator or physical device as the build target.
4. Build and run the app.

Reference

EvervaultCore

Evervault.shared.config(teamId: String, appId: String)

A shared instance of the Evervault class. This is the simplest way to get up and running if you only need to use a single Evervault team/app.

1import EvervaultCore
2
3Evervault.shared.configure(teamId: "<TEAM_ID>", appId: "<APP_ID>")

Evervault(teamId: String, appId: String)

Initializes a single instance of the Evervault class. You'll need to use this initializer if you require more than one Evervault team/app.

1import EvervaultCore
2
3let evervault = Evervault(teamId: "<TEAM_ID>", appId: "<APP_ID>")

Evervault.encrypt(_ data: Any, role: String?) async throws -> Any

Encrypts the provided data using Evervault Encrypt and an optional data role.

The encrypt function supports: Boolean, Numerics, String, Array, Dictionary and Data.

Note: Data Roles aren't yet supported when encrypting data of the Data type

1let encryptedData = try await Evervault.shared.encrypt("Super Secret Password")
2// or
3let encryptedData = try await evervault.encrypt("Super Secret Password")
4// or
5let encryptedData = try await Evervault.shared.encrypt("Super Secret Password", "data-role")

EvervaultInputs

PaymentCardInput(cardData: PaymentCardData)

Create a PaymentCardInput SwiftUI view

1import EvervaultInputs
2
3struct ContentView: View {
4
5    @State private var cardData = PaymentCardData()
6
7    var body: some View {
8        VStack {
9            PaymentCardInput(cardData: $cardData)
10
11            // Data captured:
12            Text("Encrypted credit card number: \(cardData.card.number)")
13        }
14    }
15}

EvervaultEnclaves

Evervault.enclaveSession(enclaveAttestationData: AttestationData)

Create a URLSession which will attest connections to your Evervault Enclave.

1import EvervaultCore
2import EvervaultEnclaves
3
4let enclaveSession = Evervault.enclaveSession(
5  enclaveAttestationData: AttestationData(
6    enclaveName: "<ENCLAVE_NAME>",
7    pcrs: PCRs(
8      pcr0: "<PCR0>",
9      pcr1: "<PCR1>",
10      pcr2: "<PCR2>",
11      pcr8: "<PCR8>",
12    )
13  )
14)

AttestationData

Config used to compare against the attestation doc served to the client from an Enclave.

PCRs

The attestation measurements measurement expected to be embedded in the attestation document returned from an Enclave.

Using the Evervault API as a PCR Provider

The Evervault API exposes an endpoint to retrieve the PCRs for all active versions of your Enclave which you can use to keep your clients in sync with your Enclave across deployments.

1import EvervaultCore
2import EvervaultEnclaves
3
4struct AttestedEnclaveView: View {
5
6    private let enclaveName = "my-enclave"
7    private let appId = "app_123abc"
8    private let enclaveHostname = "my-enclave.app-123abc.enclave.evervault.com"
9
10    public struct EvervaultProviderResponse: Decodable {
11        public let data: [PCRs]
12
13        public init(data: [PCRs]) {
14            self.data = data
15        }
16    }
17
18    public var provider: (@escaping ([PCRs]?, Error?) -> Void) -> Void = { completion in
19        var request = URLRequest(url: URL(string: "https://api.evervault.com/enclaves/\(enclaveName)/attestation")!)
20        request.addValue(appId, forHTTPHeaderField: "x-evervault-app-id")
21
22        URLSession.shared.dataTask(with: request) { data, _, error in
23            guard let data = data, error == nil else {
24                completion(nil, error ?? NSError(domain: "Evervault Provider", code: -1, userInfo: [NSLocalizedDescriptionKey: "No data or error."]))
25                return
26            }
27            do {
28                // Decode the data into a PCRContainer
29                let container = try JSONDecoder().decode(EvervaultProviderResponse.self, from: data)
30                // Extract the PCRs array from the container and pass it to the completion handler
31                completion(container.data, nil)
32            } catch {
33                print("Error: ", error.localizedDescription)
34                completion(nil, error)
35            }
36        }.resume()
37    }
38
39    @State private var responseText: String? = nil
40
41    var body: some View {
42        Group {
43            if let responseText {
44                Text(responseText)
45            } else {
46                Text("Loading...")
47            }
48        }
49        .padding()
50        .task {
51            let url = URL(string: "https://\(enclaveHostname)/")!
52            let urlSession = Evervault.enclaveAttestationSession(
53                enclaveAttestationData: EnclaveAttestationData(
54                    enclaveName: enclaveName,
55                    appUuid: appId,
56                    provider: provider
57                )
58            )
59
60            do {
61                let response = try await urlSession.data(from: url)
62                print(response)
63            } catch {
64                responseText = error.localizedDescription
65                print("Error: \(error.localizedDescription)")
66            }
67        }
68    }
69}