GAEN Server Setup
- Arthur Gibson
In order to run E2E tests with the servers there would need to be a GAEN Key and Verification Servers setup and verified by Apple and Google.
Prerequisites
GAEN Entitlements from Google and Apple
Apple Bundle Identifier
Google Package Name
Production Server Options
APHL National Key Server - Available to US States and Territories.
Extreme Solution - Google Cloud Platform Infrastructure Provider
Pilot Server Options
PathCheck - Hosts a Pilot Server to streamline testing E2E. Contact your PathCheck representative for details.
Server Verification
Google and Apple require you to register information from your key server, which includes a public key and signing algorithm with them in order to enable exchanging of exposure keys.
Google Verification Submission
- Submit your request through the Google Issue Tracker.
## Google Data Format
Android Package Name:
signature_infos {
verification_key_version: "v102"
verification_key_id: "310"
signature_algorithm: "1.2.840.10045.4.3.2"
}
Public Key:
-----BEGIN PUBLIC KEY-----
....
-----END PUBLIC KEY-----
Apple Verification Submission
Apple - Submit your server information directly to Apple Developer Advocate. When ready for production Apple will need your region information.
Country: MCC: stateCode: <Empty>Bundle Identifier:
Version: Public Key:
agencyHeaderStyle:agencyHeaderTextColor: []agencyImage:agencyColor: []
agencyDisplayName_<language1>:agencyRegionName_<language1>:agencyMessage_<language1>:
agencyDisplayName_<language2>:agencyRegionName_<language2>:agencyMessage_<language2>:===========================<language1> == These fields are localized, so would have a language code appended to the end. Examples: agencyDisplayName_EN_US, agencyDisplayName_FR_FR (Example below)
agencyDisplayName | Name of the PHA for display. Used in the colored header during onboarding, in EN settings and in Exposure Notification details. PHA must provide this field. |
agencyRegionName | Name of the region the PHA manages. Used as the subtitle in the onboarding header and in various places in Settings. PHA must provide this field. |
agencyHeaderStyle | one of {0: standard, 1: icon-only left, 2: icon-only center, 3: icon-only right} |
agencyHeaderTextColor | RGB values representing black or white (0.0, 0.0, 0.0) or (1.0, 1.0, 1.0) |
agencyImage | Provide a URL to the Image Images should be PNG, with transparent background, and should be 3x assets with the dimensions below: If agencyHeaderStyle is 0: 62pt x 62pt If agencyHeaderStyle is 1,2,3: Image should have a maximum height of 62pt while not exceeding maximum width of 287pt |
agencyColor | array rgb values in the range 0.0 - 1.0 |
agencyMessage | overview / summary that appears during onboarding & in settings |
Example:
Country: United States
MCC: XXX
stateCode: CM (made up for Camelot)
Bundle Identifier: com.camelot.prod
Version: v1
Public Key:
-----BEGIN PUBLIC KEY-----
MFkwXXXXXxxxxxXXXXXXxxxxXXXXXXXxxxxxxXXXXXxxxxXXXXXxx
XXXXXxxxxxXXXXXXxxxxXXXXXXXxxxxxxXXXXXxxxxXXXXXxx==
-----END PUBLIC KEY-----
agencyDisplayName_EN_US: Camelot Department of Health
agencyDisplayName_EN_ES: Camelot Departamento de salud
agencyRegionName_EN_US: Camelot, United States
agencyMessage_EN_US: Thank you for downloading CamelotCOVID, the Camelot Department of Health (CDH) COVID-19 exposure notification app. Using this app is 100% voluntary. To learn more about CamelotCOVID please visit our website: https://www.camelotcovid.com
agencyMessage_EN_ES: Above in spansih.
agencyHeaderStyle: 0 (layout styles shown in mock)
agencyColor: [0.0, 0.0, 0.0}]
agencyHeaderTextColor: [1.0, 1.0, 1.0}]
agencyImage: https://www.camelotcovid.com/camelotcovid-logo.jpg
- Please see below for visuals
- Option 0: Art should fit in Square ratio. Art should be transparent.
- Option 1, 2 or 3: Art should be any width max height 62pt with transparent pixels.