Implement endpoint library

[gnarea]

Overview

We need to create a new library in a new repository to abstract away the low-level details of using Relaynet in an Android app.

Functionality supported

The library should handle the following; more operations may be needed.

• First-party endpoints:
  • Creation (includes registering with Android GW). We should also re-register the endpoint when the private gateway broadcasts a message saying that its certificate changed.
  • Renewal (re-registering with the Android GW before the certificate expires). This can be done behind the scenes without developer input.
  • Removal (includes cryptographically-secure destruction of the private key; i.e., replace the private key with random values before removing it).
  • List existing endpoints.
• Third-party endpoints.
  • Parcel delivery authorisation issuance (i.e., call issueParcelDeliveryAuthorization() with the appropriate arguments).
  • Public key export, for use in PDA issuance.
  • PDA renewal before expiry.
  • Parcel delivery deauthorisation (optional; subject to time availability). This depends on Implement delivery of Parcel Delivery Deauthorization awala-poweb-jvm#8 and Implement collection of Parcel Delivery Deauthorization relaynet-gateway-android#4.
• Service messages
  • Send message
  • Receive messages
• Config
  • Setup bind strategy
  • Bind to gateway
  • Unbind to gateway
  • Observe gateway status

Security

Private keys MUST be encrypted at rest with an Android KeyStore master key.

Testing

Use the Relaynet testing library in the unit tests: https://github.com/relaycorp/relaynet-jvm-testing

Open question: How can we create functional/instrumentation tests? Can we run another app (i.e., the Android Gateway) whilst running the instrumentation tests of a dummy test app? Seems unlikely.