Guides
Plan-enterprise-icon
Expo Application Services
API Reference

Expo Updates (version 1 draft)


Version 1 (draft)

Updated 2022-11-29


Introduction

This is the specification for Expo Updates, a protocol for delivering updates to Expo apps running on multiple platforms.

Conformance

Conforming servers and client libraries must fulfill all normative requirements. Conformance requirements are described in this document by both descriptive assertions and key words with clearly defined meanings.

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative portions of this document are to be interpreted as described in IETF RFC 2119. These key words may appear in lowercase and still retain their meaning unless explicitly declared as non-normative.

A conforming implementation of this protocol MAY provide additional functionality, but MUST NOT where explicitly disallowed or would otherwise result in non-conformance. Where relevant, unknown fields should be allowed and ignored by conforming clients.

Overview

Conforming servers and client libraries MUST follow the HTTP spec as described in RFC 7231 as well as the more precise guidance described in this spec.

  • An update is defined as a manifest together with the assets referenced inside the manifest.
  • A directive is defined as a message from the server that instructs clients to perform an action.

Expo Updates is a protocol for assembling and delivering updates and directives to clients.

The primary audiences of this spec are Expo Application Services and organizations that wish to manage their own update server to satisfy internal requirements.

Client

Info-icon

An app running a conformant Expo Updates client library MUST load the most recent update saved in the client library's update database, possibly after filtering by the contents of the update's manifest metadata.

The following describes how a conformant Expo Updates client library MUST retrieve a new update from a conformant server:

  1. The client library MUST make a request for the most recent update and directive, with constraints specified in the headers.
  2. If a response is received, the client library MUST process its contents:
    • For a response containing an update, the client library SHALL proceed to make additional requests to download and store any new assets specified in the manifest. The manifest and assets together are considered a new update. The client library will edit its local state to reflect that a new update has been added to the local storage. It will also update the local state with the new expo-manifest-filters and expo-server-defined-headers found in the response headers.
    • For a response containing a directive, the client library will consume the directive depending on the directive type and edit its local state accordingly.

Request

A conformant client library MUST make a GET request with the headers:

  1. expo-protocol-version: 1, to specify version 1 of this Expo Updates specification.
  2. expo-platform, to specify the platform type the client is running on.
    • iOS MUST be expo-platform: ios.
    • Android MUST be expo-platform: android.
    • If it is not one of these platforms, the server SHOULD return a 400 or a 404
  3. expo-runtime-version MUST be a runtime version compatible with the client. A runtime version stipulates the native code setup a client is running. It should be set when the client is built. For example, in an iOS client, the value may be set in a plist file.
  4. Any headers stipulated by a previous responses' server defined headers.

A conformant client library MAY send one of accept: application/expo+json, accept: application/json, or accept: multipart/mixed based on the supported response structures, though it SHOULD send accept: application/expo+json, application/json, multipart/mixed. A conformant client library MAY express preference using "q" parameters as specified in RFC 7231, which default to 1.

A conformant client library configured to perform code signing verification MUST send a expo-expect-signature header to indicate that it expects the conformant server to include the expo-signature header in the manifest response. expo-expect-signature is an Expo SFV dictionary which MAY contain any of the following key value pairs:

  • sig SHOULD contain the boolean true to indicate that it requires a conformant server to respond with the signature in the sig key.
  • keyid SHOULD contain the keyId of the public key the client will use to verify the signature
  • alg SHOULD contain the algorithm the client will use to verify the signature

Example:

expo-protocol-version: 1
accept: application/expo+json;q=0.9, application/json;q=0.8, multipart/mixed
expo-platform: *
expo-runtime-version: *
expo-expect-signature: sig, keyid="root", alg="rsa-v1_5-sha256"

Response

A conformant server MUST return a response structured in at least one of the two following response structures, MAY support either or both response structures, and when an unsupported response structure is requested the server SHOULD respond with an HTTP 406 error status. A server that wishes to respond with an incompatible response for the requested protocol version SHOULD also respond with an HTTP 406 error status instead.

  • For a response with content-type: application/json or content-type: application/expo+json, the common response headers and other response headers MUST be sent in the response headers and the manifest body MUST be sent in the response body. This format of response does not support multiple response parts and therefore does not support directives, and SHOULD respond with an HTTP 406 error status when the most recent response to be served is not an update.
  • For a response with content-type: multipart/mixed, the response MUST be structured as specified in the multipart response section.

The choice of update and headers are dependent on the values of the request headers. A conformant server MUST respond with the most recent update, ordered by creation time, satisfying all parameters and constraints imposed by the request headers. The server MAY use any properties of the request like its headers and source IP address to choose amongst several updates that all satisfy the request's constraints.

Common Response Headers

expo-protocol-version: 1
expo-sfv-version: 0
expo-manifest-filters: <expo-sfv>
expo-server-defined-headers: <expo-sfv>
cache-control: *
content-type: *
  • expo-protocol-version describes the version of the protocol defined in this spec and MUST be 1.
  • expo-sfv-version MUST be 0.
  • expo-manifest-filters is an Expo SFV dictionary. It is used to filter updates stored by the client library by the metadata attribute found in the manifest. If a field is mentioned in the filter, the corresponding field in the metadata must either be missing or equal for the update to be included. The client library MUST store the manifest filters until it is overwritten by a newer response.
  • expo-server-defined-headers is an Expo SFV dictionary. It defines headers that a client library MUST store until overwritten by a newer dictionary, and they MUST be included in every subsequent update request.
  • cache-control MUST be set to an appropriately short period of time. A value of cache-control: private, max-age=0 is recommended to ensure the newest manifest is returned. Setting longer cache ages could result in stale updates.
  • content-type MUST be determined by proactive negotiation as defined in RFC 7231. Since the client library is required to send an accept header with each manifest request, this will always be either application/expo+json, application/json; otherwise the request would return a 406 error.

Other Response Headers

expo-signature: *
  • expo-signature SHOULD contain the signature of the manifest to be used during the validation step of code signing if the request for the manifest contained the expo-expect-signature header. This is an Expo SFV dictionary which MAY contain any of the following key value pairs:
    • sig MUST contain the signature of the manifest. The name of this field matches that of expo-expect-signature.
    • keyid MAY contain the keyId of the key the server used to sign the response. The client SHOULD use the certificate that matches this keyid to verify the signature.
    • alg MAY contain the algorithm the server used to sign the response. The client SHOULD use this field only if it matches the algorithm defined for the certificate matching keyid.

Multipart Response

A update response of this format is defined by the multipart/mixed MIME type as defined by RFC 2046.

Headers for this response format are the common response headers, with the following exceptions:

  • content-type SHOULD have a multipart/mixed value as defined by RFC 2046

Part order is not strict. A multipart response with no parts should be considered a no-op (no updates or directives available), though headers SHOULD be sent nevertheless and processed by the client.

Each part is defined as follows:

  1. OPTIONAL "manifest" part:
    • MUST have part header content-disposition: inline; name="manifest".
    • MUST have part header content-type: application/json or application/expo+json.
    • SHOULD have part header expo-signature as defined in other response headers if code signing is being used.
    • The manifest body MUST be sent in the part body.
  2. OPTIONAL "extensions" part:
    • MUST have part header content-disposition: inline; name="extensions".
    • MUST have part header content-type: application/json.
    • The extensions-body MUST be sent in the part body.
  3. OPTIONAL "directive" part:
    • MUST have part header content-disposition: inline; name="directive".
    • MUST have part header content-type: application/json or application/expo+json.
    • SHOULD have part header expo-signature as defined in other response headers if code signing is being used.
    • The directive body MUST be sent in the part body.

Manifest Body

Defined as JSON conforming to both the following Manifest definition expressed in TypeScript and the detailed descriptions for each field:

type Manifest = {
  id: string;
  createdAt: string;
  runtimeVersion: string;
  launchAsset: Asset;
  assets: Asset[];
  metadata: { [key: string]: string };
  extra: { [key: string]: any };
};

type Asset = {
  hash?: string;
  key: string;
  contentType: string;
  fileExtension?: string;
  url: string;
};
  • id: The ID MUST uniquely specify the manifest.

  • createdAt: The date and time at which the update was created is essential as the client library selects the most recent update (subject to any constraints supplied by the expo-manifest-filters header). The datetime should be formatted according to ISO 8601.

  • runtimeVersion: Can be any string defined by the developer. It stipulates what native code setup is required to run the associated update.

  • launchAsset: A special asset that is the entry point of the application code. The fileExtension field will be ignored for this asset and SHOULD be omitted.

  • assets: An array of assets used by the update bundle, such as JavaScript, pictures, and fonts. All assets (including the launchAsset) should be downloaded to disk before executing the update, and a mapping of asset keys to locations on disk should be provided to application code.

  • Properties of each asset object:

    • hash: Base64URL-encoded SHA-256 hash of the file to guarantee integrity. Base64URL encoding is defined by IETF RFC 4648.
    • key: Key used to reference this asset from the update's application code. This key, for example, may be generated by a separate build step that processes the application code, such as a bundler.
    • contentType: The MIME type of the file as defined by RFC 2045. e.g. application/javascript, image/jpeg.
    • fileExtension: The suggested extension to use when a file is saved on a client. Some platforms, such as iOS, require certain file types to be saved with an extension. The extension MUST be prefixed with a .. e.g. .jpeg. In some cases, such as the launchAsset, this field will be ignored in favor of a locally determined extension. If the field is omitted and there is no locally stipulated extension, the asset will be saved without an extension, e.g. ./filename with no . at the end. A conforming client SHOULD prefix a file extension with a . if a file extension is not empty and missing the . prefix.
    • url: Location at which the file may be fetched.
  • metadata: The metadata associated with an update. It is a string-valued dictionary. The server MAY send back anything it wishes to be used for filtering the updates. The metadata MUST pass the filter defined in the accompanying expo-manifest-filters header.

  • extra: For storage of optional "extra" information such as third-party configuration. For example, if the update is hosted on Expo Application Services (EAS), the EAS project ID may be included:

    "extra": {
      "eas": {
        "projectId": "00000000-0000-0000-0000-000000000000"
      }
    }
    

Extensions Body

Defined as JSON conforming to both the following Extensions definition expressed in TypeScript and the detailed descriptions for each field:

type Extensions = {
  assetRequestHeaders: ExpoAssetHeaderDictionary;
  ...
}

type ExpoAssetHeaderDictionary = {
  [assetKey: string]: {
    [headerName: string]: string,
  };
}
  • assetRequestHeaders: MAY contain a dictionary of header (key, value) pairs to include with asset requests. Key and value MUST both be strings.

Directive Body

Defined as JSON conforming to both the following Directive definition expressed in TypeScript and the detailed descriptions for each field:

type Directive = {
  type: string;
  parameters?: { [key: string]: any };
  extra?: { [key: string]: any };
};
  • type: The type of directive directive.
  • parameters: MAY contain any extra information specific to the type.
  • extra: For storage of optional "extra" information such as third-party information. For example, if the update is hosted on Expo Application Services (EAS), the EAS project ID may be included.

A conformant client library and server MAY specify and implement directive types specific to the needs of the application. For example, Expo Application Services makes use of one type thus far, rollBackToEmbedded, which directs the expo-updates library to use the update embedded in the host application instead of any other downloaded updates.

Asset Request

A conformant client library MUST make a GET request to the asset URLs specified by the manifest. The client library SHOULD include a header accepting the asset's content type as specified in the manifest. Additionally, the client library SHOULD specify the compression encoding the client library is capable of handling.

Example headers:

accept: image/jpeg, */*
accept-encoding: br, gzip

A conformant client library MUST also include any header (key, value) pairs included in assetRequestHeaders for this asset key.

Asset Response

An asset located at a particular URL MUST NOT be changed or removed since client libraries may fetch assets for any update at any time. A conformant client MUST verify that the base64url-encoded SHA-256 hash of the asset matches the hash field for the asset from the manifest.

Asset Response Headers

The asset MUST be encoded using a compression format that the client supports according to the request's accept-encoding header. The server MAY serve uncompressed assets. The response MUST include a content-type header with the MIME type of the asset. For example:

content-encoding: br
content-type: application/javascript

An asset is RECOMMENDED to be served with a cache-control header set to a long duration as an asset located at a given URL must not change. For example:

cache-control: public, max-age=31536000, immutable

Compression

Assets SHOULD be capable of being served with Gzip and Brotli compression.

Code Signing

Expo Updates supports code signing the manifest and directive bodies. Code signing the manifest also transitively signs the assets since their hashes are present in the manifest and verified by a conformant client. A conformant client MAY request the manifest or directive be signed using a private key, and then MUST verify the signature of the manifest or directive using the corresponding code signing certificate before it is used or any corresponding manifest assets are downloaded. The client MUST verify that the signing certificate is either a self-signed, trusted root certificate or is in a certificate chain signed by a trusted root certificate. In either case, the root certificate MUST be embedded in the application or device's operating system.

  • Message-iconAsk a question on the forums
  • Edit-iconEdit this page

Was this doc helpful?