store.go

// Copyright (c) 2014 Canonical Ltd.
// Licensed under the GPLv3, see the COPYING file for details.

package textsecure

import (
	"bytes"
	"crypto/sha1"
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"strconv"
	"strings"
	"sync"

	"github.com/signal-golang/textsecure/axolotl"
	"github.com/signal-golang/textsecure/config"
	"github.com/signal-golang/textsecure/fingerprint"
	"golang.org/x/crypto/pbkdf2"

	log "github.com/sirupsen/logrus"
)

// store implements the PreKeyStore, SignedPreKeyStore,
// IdentityStore and SessionStore interfaces from the axolotl package
// Blobs are encrypted with AES-128 and authenticated with HMAC-SHA1
type store struct {
	sync.Mutex
	preKeysDir       string
	signedPreKeysDir string
	identityDir      string
	sessionsDir      string

	unencrypted bool
	aesKey      []byte
	macKey      []byte
}

var lastResortPreKeyID uint32 = 0xFFFFFF

func newStore(password, path string) (*store, error) {
	ts := &store{
		preKeysDir:       filepath.Join(path, "prekeys"),
		signedPreKeysDir: filepath.Join(path, "signed_prekeys"),
		identityDir:      filepath.Join(path, "identity"),
		sessionsDir:      filepath.Join(path, "sessions"),
		unencrypted:      password == "",
	}

	// Create dirs in case this is first run
	if err := os.MkdirAll(ts.preKeysDir, 0700); err != nil {
		return nil, err
	}
	if err := os.MkdirAll(ts.signedPreKeysDir, 0700); err != nil {
		return nil, err
	}
	if err := os.MkdirAll(ts.identityDir, 0700); err != nil {
		return nil, err
	}
	if err := os.MkdirAll(ts.sessionsDir, 0700); err != nil {
		return nil, err
	}

	// If there is a password, generate the keys from it
	if !ts.unencrypted {
		salt := make([]byte, 8)
		saltFile := filepath.Join(path, "salt")

		var err error

		// Create salt if this is first run
		if !exists(saltFile) {
			randBytes(salt)
			err = ioutil.WriteFile(saltFile, salt, 0600)
			if err != nil {
				return nil, err
			}
		} else {
			salt, err = os.ReadFile(saltFile)
			if err != nil {
				return nil, err
			}
		}

		ts.genKeys(password, salt, 1024)
	}

	return ts, nil
}

// Helpers

func idToFilename(id uint32) string {
	return fmt.Sprintf("%09d", id)
}

func filenameToID(fname string) (uint32, error) {
	var id uint32
	_, err := fmt.Sscanf(fname, "%d", &id)
	if err != nil {
		return 0, err
	}
	return uint32(id), nil
}

func (s *store) readNumFromFile(path string) (uint32, error) {
	b, err := s.readFile(path)
	if err != nil {
		return 0, err
	}
	num, err := strconv.Atoi(string(b))
	if err != nil {
		return 0, err
	}
	return uint32(num), nil
}

func (s *store) writeNumToFile(path string, num uint32) {
	b := []byte(strconv.Itoa(int(num)))
	s.writeFile(path, b)
}

func (s *store) genKeys(password string, salt []byte, count int) {
	keys := pbkdf2.Key([]byte(password), salt, count, 16+20, sha1.New)
	s.aesKey = keys[:16]
	s.macKey = keys[16:]
}

func (s *store) encrypt(plaintext []byte) ([]byte, error) {
	if s.unencrypted {
		return plaintext, nil
	}

	e, err := aesEncrypt(s.aesKey, plaintext)
	if err != nil {
		return nil, err
	}

	return appendMAC(s.macKey, e), nil
}

// ErrStoreBadMAC occurs when MAC verification fails on the records stored using password based encryption.
// The probable cause is using a wrong password.
var ErrStoreBadMAC = errors.New("wrong MAC calculated, possibly due to wrong passphrase")

func (s *store) decrypt(ciphertext []byte) ([]byte, error) {
	if s.unencrypted {
		return ciphertext, nil
	}

	macPos := len(ciphertext) - 32

	if !verifyMAC(s.macKey, ciphertext[:macPos], ciphertext[macPos:]) {
		return nil, ErrStoreBadMAC
	}

	return aesDecrypt(s.aesKey, ciphertext[:macPos])

}

func (s *store) readFile(path string) ([]byte, error) {
	b, err := os.ReadFile(path)
	if err != nil {
		return nil, err
	}
	b, err = s.decrypt(b)
	return b, err
}

func (s *store) writeFile(path string, b []byte) error {
	b, err := s.encrypt(b)
	if err != nil {
		return err
	}
	return ioutil.WriteFile(path, b, 0600)
}

// Identity store

func (s *store) GetLocalRegistrationID() (uint32, error) {
	regidfile := filepath.Join(s.identityDir, "regid")
	return s.readNumFromFile(regidfile)
}

func (s *store) SetLocalRegistrationID(id uint32) {
	regidfile := filepath.Join(s.identityDir, "regid")
	s.writeNumToFile(regidfile, id)
}

func (s *store) GetIdentityKeyPair() (*axolotl.IdentityKeyPair, error) {
	idkeyfile := filepath.Join(s.identityDir, "identity_key")
	b, err := s.readFile(idkeyfile)
	if err != nil {
		return nil, err
	}
	if len(b) != 64 {
		return nil, fmt.Errorf("identity key is %d not 64 bytes long", len(b))
	}
	return axolotl.NewIdentityKeyPairFromKeys(b[32:], b[:32]), nil
}

func (s *store) SetIdentityKeyPair(ikp *axolotl.IdentityKeyPair) error {
	idkeyfile := filepath.Join(s.identityDir, "identity_key")
	b := make([]byte, 64)
	copy(b, ikp.PublicKey.Key()[:])
	copy(b[32:], ikp.PrivateKey.Key()[:])
	return s.writeFile(idkeyfile, b)
}

func (s *store) SaveIdentity(id string, key *axolotl.IdentityKey) error {
	idkeyfile := filepath.Join(s.identityDir, "remote_"+id)
	return s.writeFile(idkeyfile, key.Key()[:])
}

func (s *store) IsTrustedIdentity(id string, key *axolotl.IdentityKey) bool {
	if config.ConfigFile.AlwaysTrustPeerID {
		// Workaround until we handle peer reregistering situations
		// more securely and with a better UI.
		return true
	}
	idkeyfile := filepath.Join(s.identityDir, "remote_"+id)
	// Trust on first use (TOFU)
	if !exists(idkeyfile) {
		return true
	}
	b, err := s.readFile(idkeyfile)
	if err != nil {
		return false
	}
	return bytes.Equal(b, key.Key()[:])
}

// MyIdentityKey returns our serialized public identity key
func MyIdentityKey() []byte {
	return identityKey.PublicKey.Serialize()
}

// UnknownContactError is returned when an unknown group id is encountered
type UnknownContactError struct {
	id string
}

func (err UnknownContactError) Error() string {
	return fmt.Sprintf("unknown contact ID %s", err.id)
}

// ContactIdentityKey returns the serialized public key of the given contact
func ContactIdentityKey(id string) ([]byte, error) {
	s := textSecureStore
	idClean, err := recID(id)
	if err != nil {
		return nil, err
	}
	idkeyfile := filepath.Join(s.identityDir, "remote_"+idClean)
	if !exists(idkeyfile) {
		return nil, UnknownContactError{id}
	}
	b, err := s.readFile(idkeyfile)
	if err != nil {
		return nil, err
	}
	return append([]byte{5}, b...), nil
}

func GetFingerprint(remoteUUID string, remoteIdentifier string) ([]string, []byte, error) {

	localIdentifier := config.ConfigFile.Tel
	localIdentityKey := MyIdentityKey()

	remoteIdentityKey, err := ContactIdentityKey(remoteUUID)
	if err != nil {
		return nil, nil, err
	}

	numericFingerprint, scannableFingerprint, err := fingerprint.CreateFingerprintSimple(1, localIdentifier, localIdentityKey, remoteIdentifier, remoteIdentityKey)
	if err != nil {
		return nil, nil, err
	}
	return numericFingerprint, scannableFingerprint, nil
}

// Prekey and signed prekey store

func (s *store) preKeysFilePath(id uint32) string {
	return filepath.Join(s.preKeysDir, idToFilename(id))
}

func (s *store) signedPreKeysFilePath(id uint32) string {
	return filepath.Join(s.signedPreKeysDir, idToFilename(id))
}

func (s *store) LoadPreKey(id uint32) (*axolotl.PreKeyRecord, error) {
	b, err := s.readFile(s.preKeysFilePath(id))
	if err != nil {
		return nil, err
	}

	record, err := axolotl.LoadPreKeyRecord(b)
	if err != nil {
		return nil, err
	}

	return record, nil
}

func (s *store) LoadSignedPreKey(id uint32) (*axolotl.SignedPreKeyRecord, error) {
	b, err := s.readFile(s.signedPreKeysFilePath(id))
	if err != nil {
		return nil, err
	}

	record, err := axolotl.LoadSignedPreKeyRecord(b)
	if err != nil {
		return nil, err
	}

	return record, nil
}

func (s *store) LoadSignedPreKeys() []axolotl.SignedPreKeyRecord {
	keys := []axolotl.SignedPreKeyRecord{}
	//FIXME
	return keys
}

func (s *store) StorePreKey(id uint32, record *axolotl.PreKeyRecord) error {
	b, err := record.Serialize()
	if err != nil {
		return err
	}
	return s.writeFile(s.preKeysFilePath(id), b)
}

func (s *store) StoreSignedPreKey(id uint32, record *axolotl.SignedPreKeyRecord) error {
	b, err := record.Serialize()
	if err != nil {
		return err
	}
	return s.writeFile(s.signedPreKeysFilePath(id), b)
}

func exists(path string) bool {
	_, err := os.Stat(path)
	return err == nil
}

func (s *store) valid() bool {
	return s.ContainsPreKey(lastResortPreKeyID)
}

func (s *store) ContainsPreKey(id uint32) bool {
	return exists(s.preKeysFilePath(id))
}

func (s *store) ContainsSignedPreKey(id uint32) bool {
	return exists(s.signedPreKeysFilePath(id))
}

func (s *store) RemovePreKey(id uint32) {
	_ = os.Remove(s.preKeysFilePath(id))
}

func (s *store) RemoveSignedPreKey(id uint32) {
	_ = os.Remove(s.signedPreKeysFilePath(id))
}

// HTTP API store
func (s *store) storeHTTPPassword(password string) {
	passFile := filepath.Join(s.identityDir, "http_password")
	s.writeFile(passFile, []byte(password))
}

func (s *store) loadHTTPPassword() (string, error) {
	passFile := filepath.Join(s.identityDir, "http_password")
	b, err := s.readFile(passFile)
	if err != nil {
		return "", err
	}
	return string(b), nil
}

func (s *store) storeHTTPSignalingKey(key []byte) {
	keyFile := filepath.Join(s.identityDir, "http_signaling_key")
	s.writeFile(keyFile, key)
}

func (s *store) loadHTTPSignalingKey() ([]byte, error) {
	keyFile := filepath.Join(s.identityDir, "http_signaling_key")
	b, err := s.readFile(keyFile)
	if err != nil {
		return nil, err
	}
	return b, nil
}

// Session store

func (s *store) sessionFilePath(recipientID string, deviceID uint32) string {
	return filepath.Join(s.sessionsDir, fmt.Sprintf("%s_%d", recipientID, deviceID))
}

func (s *store) GetSubDeviceSessions(recipientID string) []uint32 {
	sessions := []uint32{}

	filepath.Walk(s.sessionsDir, func(path string, fi os.FileInfo, err error) error {
		if !fi.IsDir() {
			i := strings.LastIndex(path, "_")
			id, _ := strconv.Atoi(path[i+1:])
			sessions = append(sessions, uint32(id))
		}
		return nil
	})
	return sessions
}

func (s *store) LoadSession(recipientID string, deviceID uint32) (*axolotl.SessionRecord, error) {
	sfile := s.sessionFilePath(recipientID, deviceID)
	b, err := s.readFile(sfile)
	if err != nil {
		return axolotl.NewSessionRecord(), nil
	}
	record, err := axolotl.LoadSessionRecord(b)
	if err != nil {
		return nil, err
	}

	return record, nil
}

func (s *store) StoreSession(recipientID string, deviceID uint32, record *axolotl.SessionRecord) error {
	sfile := s.sessionFilePath(recipientID, deviceID)
	b, err := record.Serialize()
	if err != nil {
		return err
	}
	return s.writeFile(sfile, b)
}

func (s *store) ContainsSession(recipientID string, deviceID uint32) bool {
	sfile := s.sessionFilePath(recipientID, deviceID)
	return exists(sfile)
}

func (s *store) DeleteSession(recipientID string, deviceID uint32) {
	sfile := s.sessionFilePath(recipientID, deviceID)
	_ = os.Remove(sfile)
}

func (s *store) DeleteAllSessions(recipientID string) {
	log.Debugf("Deleting all sessions for %s\n", recipientID)
	sessions := s.GetSubDeviceSessions(recipientID)
	for _, dev := range sessions {
		_ = os.Remove(s.sessionFilePath(recipientID, dev))
	}
}

var textSecureStore *store

func setupStore() error {
	var err error

	password := ""
	if !config.ConfigFile.UnencryptedStorage {
		password = config.ConfigFile.StoragePassword
		if password == "" {
			password = client.GetStoragePassword()
		}
	}

	textSecureStore, err = newStore(password, config.ConfigFile.StorageDir)
	if err != nil {
		return err
	}

	if err := setupGroups(); err != nil {
		return err
	}

	return nil
}