Apple DeviceCheck API

Warnings

• breaking Decorators for web frameworks (`@validate_device`, etc.) were reworked in version 1.2.0. If you were using these decorators prior to this version, review the changes and update your implementation accordingly.
  Fix: Refer to the library's GitHub README or documentation for updated decorator usage patterns.
• gotcha The `dev_environment` parameter in `DeviceCheck` initialization is crucial. It defaults to `True` (development) for new instances. Ensure it is explicitly set to `False` in production to interact with Apple's production DeviceCheck environment. Incorrect setting will lead to validation failures or incorrect bit states.
  Fix: Always set `dev_environment=False` in production deployments and `True` (or omit if default desired) for development/sandbox environments. Use environment variables for configuration.
• gotcha Apple's DeviceCheck API, and by extension this library, only works on physical iOS devices. It will not function correctly on simulators.
  Fix: Test DeviceCheck functionality on actual iOS hardware. Use mock environment variables (e.g., `MOCK_DEVICE_CHECK_DECORATOR_TOKEN`) for local development if real device testing is not feasible for every iteration.
• gotcha Version 1.3.0 introduced dedicated asyncio support. When working with asynchronous code, ensure you import `AsyncioDeviceCheck` from `devicecheck.asyncio` instead of the top-level `DeviceCheck` class to leverage `async/await` functionality.
  Fix: For asyncio, use `from devicecheck.asyncio import AsyncioDeviceCheck`. The rest of the asynchronous network methods will need to be `await`ed.
• gotcha The private key (`.p8` file) used for authentication with Apple's API is highly sensitive. It should never be hardcoded or committed directly into source control. Always load it securely, for example, from an environment variable or a secure vault at runtime.
  Fix: Store the private key path or content in an environment variable (`APPLE_PRIVATE_KEY_PATH` or `APPLE_PRIVATE_KEY_CONTENT`) and retrieve it at runtime. Ensure proper access controls are on the `.p8` file.

Install

• pip install devicecheck Install latest version

Imports

• DeviceCheck

  from devicecheck import DeviceCheck

• AsyncioDeviceCheck

  from devicecheck.asyncio import AsyncioDeviceCheck

  Asyncio specific classes are in a dedicated 'asyncio' submodule since v1.3.0.
• validate_device

  from devicecheck.decorators import validate_device

• DCSupportedFrameworks

  from devicecheck.decorators import DCSupportedFrameworks

• async_validate_device

  from devicecheck.decorators import async_validate_device

• DCSupportedAsyncFrameworks

  from devicecheck.decorators import DCSupportedAsyncFrameworks

Quickstart

This quickstart demonstrates how to initialize the `DeviceCheck` client and validate a device token. It uses environment variables for sensitive Apple credentials, which is a recommended security practice. Remember to obtain `team_id`, `bundle_id`, `key_id`, and the `private_key` path from your Apple Developer account, and set `dev_environment` appropriately for your testing or production environment. The `device_token` must be generated by your iOS application on a physical device.

import os
from devicecheck import DeviceCheck

# Configure DeviceCheck client using environment variables for security
dc_client = DeviceCheck(
    team_id=os.environ.get("APPLE_TEAM_ID", ""),
    bundle_id=os.environ.get("APPLE_BUNDLE_ID", ""),
    key_id=os.environ.get("APPLE_KEY_ID", ""),
    private_key=os.environ.get("APPLE_PRIVATE_KEY_PATH", ""),
    dev_environment=bool(os.environ.get("DC_DEV_ENVIRONMENT", "False").lower() == "true"),
    # Set raise_on_error=True to get Python exceptions on API errors
    raise_on_error=True
)

# IMPORTANT: Replace with an actual device token generated by your iOS app
# For testing, you might use a mocked token if the library supports it via env vars.
device_token = os.environ.get("TEST_DEVICE_TOKEN", "YOUR_ACTUAL_DEVICE_TOKEN_HERE")

if not device_token:
    print("Error: TEST_DEVICE_TOKEN environment variable not set, or placeholder not replaced.")
    print("Please provide a valid device token from your iOS app for real testing.")
else:
    try:
        # Validate the device token
        validation_result = dc_client.validate_device_token(device_token)
        
        if validation_result.is_ok:
            print('Device is valid!')
            # Example: Query bits data if needed
            # bits_data = dc_client.query_two_bits(device_token)
            # print(f'Bit 0: {bits_data.bit0}, Bit 1: {bits_data.bit1}')
        else:
            print(f'Device validation failed: {validation_result.description}')

    except Exception as e:
        print(f"An error occurred during DeviceCheck operation: {e}")