github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/engine/fakeusers_test.go

// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package engine

import (
	"testing"

	"github.com/keybase/client/go/libkb"
	"github.com/stretchr/testify/require"
)

func createFakeUserWithNoKeys(tc libkb.TestContext) (username, passphrase string) {
	username, email := fakeUser(tc.T, "login")
	passphrase = fakePassphrase(tc.T)
	m := NewMetaContextForTest(tc)
	s := NewSignupEngine(tc.G, nil)

	f := func() error {
		m = m.WithNewProvisionalLoginContext()

		// going to just run the join step of signup engine
		if err := s.genPassphraseStream(m, passphrase, false /* randomPW */); err != nil {
			return err
		}

		if err := s.join(m, SignupEngineRunArg{
			Username:   username,
			Email:      email,
			InviteCode: libkb.TestInvitationCode,
			SkipMail:   true,
		}); err != nil {
			return err
		}
		m = m.CommitProvisionalLogin()
		return nil
	}
	if err := f(); err != nil {
		tc.T.Fatal(err)
	}

	return username, passphrase
}

// createFakeUserWithPGPOnly creates a new fake/testing user, who signed
// up on the Web site, and used the Web site to generate his/her key.  They
// used triplesec-encryption and synced their key to the keybase servers.
func createFakeUserWithPGPOnly(t *testing.T, tc libkb.TestContext) *FakeUser {
	fu := NewFakeUserOrBust(tc.T, "login")

	secui := &libkb.TestSecretUI{Passphrase: fu.Passphrase}
	uis := libkb.UIs{
		GPGUI:    &gpgtestui{},
		SecretUI: secui,
		LogUI:    tc.G.UI.GetLogUI(),
		LoginUI:  &libkb.TestLoginUI{Username: fu.Username},
	}
	s := NewSignupEngine(tc.G, nil)
	m := NewMetaContextForTest(tc).WithUIs(uis)

	// Keep this provisional login around indefinitely, since we're going to need it to
	// post PGP keys below. This isn't a modern use for our software, but we have this code
	// to emulate old accounts provisioned by deprecated login paths.
	m = m.WithNewProvisionalLoginContext()
	err := s.genPassphraseStream(m, fu.Passphrase, false /* randomPW */)
	require.NoError(t, err)
	err = s.join(m, SignupEngineRunArg{
		Username:   fu.Username,
		Email:      fu.Email,
		InviteCode: libkb.TestInvitationCode,
		SkipMail:   true,
	})
	require.NoError(t, err)
	err = s.fakeLKS(m)
	require.NoError(t, err)
	m.Dump()

	// Generate a new test PGP key for the user, and specify the PushSecret
	// flag so that their triplesec'ed key is pushed to the server.
	gen := libkb.PGPGenArg{
		PrimaryBits: 1024,
		SubkeyBits:  1024,
	}
	gen.AddDefaultUID(tc.G)
	peng := NewPGPKeyImportEngine(tc.G, PGPKeyImportEngineArg{
		Gen:        &gen,
		PushSecret: true,
		Lks:        s.lks,
		NoSave:     true,
	})

	err = RunEngine2(m, peng)
	require.NoError(t, err)
	fu.User, err = libkb.LoadMe(libkb.NewLoadUserArgWithMetaContext(m).WithPublicKeyOptional())
	require.NoError(t, err)

	return fu
}

// private gpg key not pushed to server
func createFakeUserWithPGPPubOnly(t *testing.T, tc libkb.TestContext) *FakeUser {
	fu := NewFakeUserOrBust(t, "login")
	if err := tc.GenerateGPGKeyring(fu.Email); err != nil {
		t.Fatal(err)
	}

	secui := &libkb.TestSecretUI{Passphrase: fu.Passphrase}
	s := NewSignupEngine(tc.G, nil)
	uis := libkb.UIs{
		GPGUI:    &gpgPubOnlyTestUI{},
		SecretUI: secui,
		LogUI:    tc.G.UI.GetLogUI(),
		LoginUI:  &libkb.TestLoginUI{Username: fu.Username},
	}
	m := NewMetaContextForTest(tc).WithUIs(uis)

	f := func() error {
		m = m.WithNewProvisionalLoginContext()
		if err := s.genPassphraseStream(m, fu.Passphrase, false /* randomPW */); err != nil {
			return err
		}

		if err := s.join(m, SignupEngineRunArg{
			Username:   fu.Username,
			Email:      fu.Email,
			InviteCode: libkb.TestInvitationCode,
			SkipMail:   true,
		}); err != nil {
			return err
		}

		if err := s.fakeLKS(m); err != nil {
			return err
		}

		if err := s.addGPG(m, false, false); err != nil {
			return err
		}
		m = m.CommitProvisionalLogin()
		return nil
	}
	if err := f(); err != nil {
		t.Fatal(err)
	}

	return fu
}

// multiple pgp keys
func createFakeUserWithPGPMult(t *testing.T, tc libkb.TestContext) *FakeUser {
	fu := NewFakeUserOrBust(t, "login")
	if err := tc.GenerateGPGKeyring(fu.Email, "xxx@xxx.com"); err != nil {
		t.Fatal(err)
	}

	secui := &libkb.TestSecretUI{Passphrase: fu.Passphrase}
	s := NewSignupEngine(tc.G, nil)
	uis := libkb.UIs{
		GPGUI:    &gpgtestui{},
		SecretUI: secui,
		LogUI:    tc.G.UI.GetLogUI(),
		LoginUI:  &libkb.TestLoginUI{Username: fu.Username},
	}
	m := NewMetaContextForTest(tc).WithUIs(uis)

	f := func() error {
		m = m.WithNewProvisionalLoginContext()
		if err := s.genPassphraseStream(m, fu.Passphrase, false /* randomPW */); err != nil {
			return err
		}

		if err := s.join(m, SignupEngineRunArg{
			Username:   fu.Username,
			Email:      fu.Email,
			InviteCode: libkb.TestInvitationCode,
			SkipMail:   true,
		}); err != nil {
			t.Fatal(err)
		}

		fu.User = s.GetMe()

		// fake the lks:
		if err := s.fakeLKS(m); err != nil {
			return err
		}

		if err := s.addGPG(m, false, false); err != nil {
			return err
		}

		// hack the gpg ui to select a different key:
		m = m.WithGPGUI(&gpgtestui{index: 1})
		if err := s.addGPG(m, true, false); err != nil {
			return nil
		}
		m = m.CommitProvisionalLogin()
		return nil
	}

	if err := f(); err != nil {
		t.Fatal(err)
	}

	// now it should have two pgp keys...

	return fu
}

func createFakeUserWithPGPSibkey(tc libkb.TestContext) *FakeUser {
	fu := CreateAndSignupFakeUser(tc, "pgp")

	arg := PGPKeyImportEngineArg{
		Gen: &libkb.PGPGenArg{
			PrimaryBits: 768,
			SubkeyBits:  768,
		},
	}
	if err := arg.Gen.MakeAllIds(tc.G); err != nil {
		tc.T.Fatal(err)
	}
	uis := libkb.UIs{
		LogUI:    tc.G.UI.GetLogUI(),
		SecretUI: fu.NewSecretUI(),
	}
	eng := NewPGPKeyImportEngine(tc.G, arg)
	m := NewMetaContextForTest(tc).WithUIs(uis)
	err := RunEngine2(m, eng)
	if err != nil {
		tc.T.Fatal(err)
	}
	return fu
}

func createFakeUserWithPGPSibkeyPaper(tc libkb.TestContext) *FakeUser {
	fu := CreateAndSignupFakeUserPaper(tc, "pgp")

	arg := PGPKeyImportEngineArg{
		Gen: &libkb.PGPGenArg{
			PrimaryBits: 768,
			SubkeyBits:  768,
		},
	}
	if err := arg.Gen.MakeAllIds(tc.G); err != nil {
		tc.T.Fatal(err)
	}
	uis := libkb.UIs{
		LogUI:    tc.G.UI.GetLogUI(),
		SecretUI: fu.NewSecretUI(),
	}
	eng := NewPGPKeyImportEngine(tc.G, arg)
	m := NewMetaContextForTest(tc).WithUIs(uis)
	err := RunEngine2(m, eng)
	if err != nil {
		tc.T.Fatal(err)
	}
	return fu
}

func createFakeUserWithPGPSibkeyPushed(tc libkb.TestContext) *FakeUser {
	fu := CreateAndSignupFakeUser(tc, "pgp")

	arg := PGPKeyImportEngineArg{
		Gen: &libkb.PGPGenArg{
			PrimaryBits: 768,
			SubkeyBits:  768,
		},
		PushSecret: true,
		NoSave:     true,
	}
	if err := arg.Gen.MakeAllIds(tc.G); err != nil {
		tc.T.Fatal(err)
	}
	uis := libkb.UIs{
		LogUI:    tc.G.UI.GetLogUI(),
		SecretUI: fu.NewSecretUI(),
	}
	eng := NewPGPKeyImportEngine(tc.G, arg)
	m := NewMetaContextForTest(tc).WithUIs(uis)
	err := RunEngine2(m, eng)
	if err != nil {
		tc.T.Fatal(err)
	}
	return fu
}

func createFakeUserWithPGPSibkeyPushedPaper(tc libkb.TestContext) *FakeUser {
	fu := CreateAndSignupFakeUserPaper(tc, "pgp")

	arg := PGPKeyImportEngineArg{
		Gen: &libkb.PGPGenArg{
			PrimaryBits: 768,
			SubkeyBits:  768,
		},
		PushSecret: true,
		NoSave:     true,
	}
	if err := arg.Gen.MakeAllIds(tc.G); err != nil {
		tc.T.Fatal(err)
	}
	uis := libkb.UIs{
		LogUI:    tc.G.UI.GetLogUI(),
		SecretUI: fu.NewSecretUI(),
	}
	eng := NewPGPKeyImportEngine(tc.G, arg)
	m := NewMetaContextForTest(tc).WithUIs(uis)
	err := RunEngine2(m, eng)
	if err != nil {
		tc.T.Fatal(err)
	}
	return fu
}

func createFakeUserWithPGPSibkeyPregen(tc libkb.TestContext, pregen *libkb.PGPKeyBundle) *FakeUser {
	fu := CreateAndSignupFakeUser(tc, "pgp")

	arg := PGPKeyImportEngineArg{
		Pregen: pregen,
	}
	uis := libkb.UIs{
		LogUI:    tc.G.UI.GetLogUI(),
		SecretUI: fu.NewSecretUI(),
	}
	eng := NewPGPKeyImportEngine(tc.G, arg)
	m := NewMetaContextForTest(tc).WithUIs(uis)
	err := RunEngine2(m, eng)
	if err != nil {
		tc.T.Fatal(err)
	}
	return fu
}

// fakeLKS is used to create a lks that has the server half when
// creating a fake user that doesn't have a device.
func (s *SignupEngine) fakeLKS(m libkb.MetaContext) error {
	s.lks = libkb.NewLKSec(s.ppStream, s.uid)
	return s.lks.GenerateServerHalf()
}