Skip to content

/ fxakeys

Permalink
master
Switch branches/tags

fxakeys/API.rst

Go to file
 
 
Cannot retrieve contributors at this time
Key Server API GET /<email>/apps/<appid>/key GET /<email>/apps POST /<email>/apps/<appid>/key DELETE /<email>/apps/<appid>/key
66 lines (43 sloc) 1.78 KB
Raw Blame

Key Server API

The server URLs semantics is mostly REST semantics

https://<server>/<api path>/<version>/<further instructions>

The rest of this document only presents the <further instructions> part and makes the assumption that the API is served behind an ssl connection that protects the requests header, body and query options during transport, as well as the responses content.

The proposed service is implemented as an FxA content provider, so it accepts Bearer Tokens with the keys: scope as a form of authentication.

GET /<email>/apps/<appid>/key

  • scope: keys
  • authentication: FxA Oauth token
  • authorization: any FxA user with a valid OAuth token and with an existing key pair for this app.

Returns the keys of a given user for a given app. The returned value is a json mapping containing:

  • pubKey: the public key
  • encPrivKey: the encrypted private key, if the authenticated user matches the email

GET /<email>/apps

  • scope: keys
  • authentication: FxA Oauth token
  • authorization: the FxA user owning the e-mail

Used to retrieve the list of apps a user is registered to. Returns a mapping containing a single key:

  • apps: a list of apps identifiers

POST /<email>/apps/<appid>/key

  • scope: keys:write
  • authentication: FxA Oauth token
  • authorization: the FxA user owning the e-mail

Used to post a keypair to the server. The POST body is a Json mapping containing:

  • pubKey: the public key
  • encPrivKey: the encrypted private key

DELETE /<email>/apps/<appid>/key

  • scope: keys:write
  • authentication: FxA Oauth token
  • authorization: the FxA user owning the e-mail

Removes the key.