status-im
/
specs
mirror of https://github.com/status-im/specs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
specs/status-account-spec.md

11 KiB
Raw Blame History

Status Account Specification

Version: 0.1 (Draft)

Authors: Corey Petty corey@status.im, Oskar Thorén oskar@status.im (alphabetical order)

Abstract

TBD.

Table of Contents

Introduction

The core concept of an account in Status is a set of cryptographic keypairs. Namely, the combination of the following:

  1. a whisper chat identity keypair
  2. a set of cryptocurrency wallet keypairs

Everything else associated with the contact is either verified or derived from the above items, including:

  • Ethereum address (future verification, currently the same base keypair)
  • 3 word mnemonic name
  • identicon
  • message signatures

1 Initial Key Generation

1.1 Public/Private Keypairs

  • An ECDSA (secp256k1 curve) public/private keypair MUST be generated via a BIP43 derived path from a BIP39 mnemonic seed phrase.
  • The default paths are defined as such:
    • Whisper Chat Key (IK): m/43'/60'/1581'/0'/0 (post Multiaccount integration)
    • DB encryption Key (DBK): m/43'/60'/1581'/1'/0 (post Multiaccount integration)
    • Status Wallet paths: m/44'/60'/0'/0'/i starting at i=0
      • following BIP44
      • NOTE: this (i=0) is also the current (and only) path for Whisper key before Multiaccount integration

1.2 X3DH Prekey bundle creation

  • Status follows the X3DH prekey bundle scheme that Open Whisper Systems outlines in their documentation with the following exceptions:
    • Because there are no central servers, we do not publish one-time keys OPK or perform DH including them.
  • A client MUST create X3DH prekey bundles, each defined by the following items:
    • Identity Key: IK
    • Signed prekey: SPK
    • Prekey signature: Sig(IK, Encode(SPK))
    • Timestamp
  • These bundles are made available in a variety of ways, as defined in section 2.1.

1.3 Register at push notification system

If you want to receive and send push notifications, you MUST register a push notification server. This part is currently underspecified. You MAY choose to not do this.

2 Account Broadcasting

  • A user is responsible for broadcasting certain information publicly so that others may contact them.

2.1 X3DH Prekey bundles

  • A client SHOULD regenerate a new X3DH prekey bundle every 24 hours. This MAY be done in a lazy way, such that a client that does not come online past this time period does not regenerate or broadcast bundles.
  • The current bundle MUST be broadcast on a whisper topic specific to his Identity Key, {IK}-contact-code, intermittently. This MAY be done every 6 hours.
  • A bundle MUST accompany every message sent.
  • TODO: retreival of long-time offline users bundle via {IK}-contact-code

3 Optional Account additions

3.1 ENS Username

  • A user MAY register a public username on the Ethereum Name System (ENS). This username is a user-chosen subdomain of the stateofus.eth ENS registration that maps to their whisper identity key (IK).

3.2 User Chosen Name

  • An account MAY create a display name to replace the IK generated 3-word pseudonym in chat screens. This chosen display name will become part of the publicly broadcasted profile of the account.

3.3 User Profile Picture

  • An account MAY edit the IK generated identicon with a chosen picture. This picture will become part of the publicly broadcasted profile of the account.

4 Trust establishment

Trust establishment deals with users verifying they are communicating with who they think they are.

Terms Glossary

term description
privkey ECDSA secp256k1 private key
pubkey ECDSA secp256k1 public key
whisper key pubkey for chat with HD derivation path m/44'/60'/0'/0/0

1. Contact Discovery

1.1 Public channels

  • Public group channels in Status are a broadcast/subscription system. All public messages are encrypted with a symmetric key drived from the channel name, K_{pub,sym}, which is publicly known.
  • A public group channel's symmetric key MUST creation must follow the web3 API's web3.ssh.generateSymKeyFromPassword function
  • In order to post to a public group channel, a client MUST have a valid account created (as per section Account Creation Specification).
  • In order to listen to a public group channel, a client must subscribe to the channel name. The sender of a message is derived from the message's signature.
  • Discovery of channel names is not currently part of the protocol, and is typically done out of band. If a channel name is used that has not been used, it will be created.
  • A client MUST sign the message otherwise it will be discarded by the recipients.
  • channel name specification:
    • matches [a-z0-9\-]
    • is not a public key

1.2 Private 1:1 messages

This can be done in a the following ways:

  1. scanning a user generated QR code
  2. discovery through the Status app
  3. asyncronous X3DH key exchange
  4. public key via public channel listening
    • status-react/src/status_im/contact_code/core.cljs
  5. contact codes
  6. decentralized storage (not implemented)
  7. whisper

2. Initial Key Exchange

Contact Request

Bundles

  • An X3DH prekey bundle is defined as ([code(https://github.com/status-im/status-go/messaging/chat/protobuf/encryption.pb.go)]): 
    Identity                // Identity key
SignedPreKeys           // a map of installation id to array of signed prekeys by that installation id
Signature               // Prekey signature
Timestamp               // When the bundle was lasted created locally
    • include BundleContainer???
  • a new bundle SHOULD be created at least every 12 hours
  • a bundle is only generated when it is used
  • a bundle MUST be distributed on the contact code channel (NOTE: define this where?)

QR code

  • A generated QR code should include a X3DH bundle set along with the contact code but I can't find the code to do so.

4. Contact Verification

Once you have the information of a contact, the following can be used to verify that the key material is as it should be.

Identicon

A low-poly identicon is deterministically generated from the whisper chat public key. This can then be compared out of band to ensure the reciever's public key is the one you have locally.

3 word pseudonym / whisper key fingerprint

Status generates a deterministic 3-word random pseudonym from the whisper chat public key. This pseudonym acts as a human readable fingerprint to the whisper chat public key. This name also shows when viewing a contact's public profile and in the chat UI.

ENS name

Status offers the ability to register a mapping of a human readable subdomain of stateofus.eth to their whisper chat public key. This registration is purchased (currently by staking 10 SNT) and stored on the Ethereum mainnet blockchain for public lookup.

Security Considerations

TBD.