github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/teams/rotate_hidden_test.go

package teams

import (
	"context"
	"testing"
	"time"

	"github.com/keybase/client/go/engine"
	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/protocol/keybase1"
	"github.com/keybase/clockwork"
	"github.com/stretchr/testify/require"
)

func TestRotateHiddenSelf(t *testing.T) {
	tc, owner, other, _, name := memberSetupMultiple(t)
	defer tc.Cleanup()

	err := SetRoleWriter(context.TODO(), tc.G, name, other.Username)
	require.NoError(t, err)
	team, err := GetForTestByStringName(context.TODO(), tc.G, name)
	require.NoError(t, err)
	require.Equal(t, keybase1.PerTeamKeyGeneration(1), team.Generation())

	secretBefore := team.Data.PerTeamKeySeedsUnverified[team.Generation()].Seed.ToBytes()
	keys1, err := team.AllApplicationKeys(context.TODO(), keybase1.TeamApplication_CHAT)
	require.NoError(t, err)
	require.Equal(t, len(keys1), 1)
	require.Equal(t, keys1[0].KeyGeneration, keybase1.PerTeamKeyGeneration(1))

	err = team.Rotate(context.TODO(), keybase1.RotationType_VISIBLE)
	require.NoError(t, err)
	after, err := GetForTestByStringName(context.TODO(), tc.G, name)
	require.NoError(t, err)
	require.Equal(t, keybase1.PerTeamKeyGeneration(2), after.Generation())
	secretAfter := after.Data.PerTeamKeySeedsUnverified[after.Generation()].Seed.ToBytes()
	require.False(t, libkb.SecureByteArrayEq(secretAfter, secretBefore))
	assertRole(tc, name, owner.Username, keybase1.TeamRole_OWNER)
	assertRole(tc, name, other.Username, keybase1.TeamRole_WRITER)

	keys2, err := after.AllApplicationKeys(context.TODO(), keybase1.TeamApplication_CHAT)
	require.NoError(t, err)
	require.Equal(t, len(keys2), 2)
	require.Equal(t, keys2[0].KeyGeneration, keybase1.PerTeamKeyGeneration(1))
	require.Equal(t, keys1[0].Key, keys2[0].Key)

	for i := 0; i < 3; i++ {
		team, err = GetForTestByStringName(context.TODO(), tc.G, name)
		require.NoError(t, err)
		err = team.Rotate(context.TODO(), keybase1.RotationType_HIDDEN)
		require.NoError(t, err)
		team, err = GetForTestByStringName(context.TODO(), tc.G, name)
		require.NoError(t, err)
		err = team.Rotate(context.TODO(), keybase1.RotationType_VISIBLE)
		require.NoError(t, err)
	}

	team, err = GetForTestByStringName(context.TODO(), tc.G, name)
	require.NoError(t, err)
	keys3, err := team.AllApplicationKeys(context.TODO(), keybase1.TeamApplication_CHAT)
	require.NoError(t, err)
	require.Equal(t, len(keys3), 8)
	require.Equal(t, keys3[0].KeyGeneration, keybase1.PerTeamKeyGeneration(1))
	require.Equal(t, keys1[0].Key, keys3[0].Key)
	require.Equal(t, keys2[1].Key, keys3[1].Key)
}

func TestRotateHiddenOther(t *testing.T) {
	fus, tcs, cleanup := setupNTests(t, 2)
	defer cleanup()

	t.Logf("u0 creates a team (seqno:1)")
	teamName, teamID := createTeam2(*tcs[0])

	t.Logf("U0 adds U1 to the team (2)")
	_, err := AddMember(context.TODO(), tcs[0].G, teamName.String(), fus[1].Username, keybase1.TeamRole_ADMIN, nil)
	require.NoError(t, err)

	ctx := context.TODO()
	numKeys := 1

	rotate := func(h bool) {
		g := tcs[0].G
		team, err := GetForTestByID(ctx, g, teamID)
		require.NoError(t, err)
		typ := keybase1.RotationType_VISIBLE
		if h {
			typ = keybase1.RotationType_HIDDEN
		}
		err = team.rotate(ctx, typ)
		require.NoError(t, err)
		numKeys++
	}

	checkForUser := func(i int) {
		g := tcs[i].G
		team, err := GetForTestByID(ctx, g, teamID)
		require.NoError(t, err)
		keys, err := team.AllApplicationKeys(context.TODO(), keybase1.TeamApplication_CHAT)
		require.NoError(t, err)
		require.Equal(t, len(keys), numKeys)
	}

	check := func() {
		checkForUser(0)
		checkForUser(1)
	}

	for i := 0; i < 5; i++ {
		rotate(i%2 == 0)
		check()
	}

	mctx1 := libkb.NewMetaContext(ctx, tcs[1].G)
	ch, err := tcs[1].G.GetHiddenTeamChainManager().Load(mctx1, teamID)
	require.NoError(t, err)
	require.Equal(t, keybase1.Seqno(2), ch.RatchetSet.Ratchets[keybase1.RatchetType_MAIN].Triple.Seqno)
}

func TestRotateHiddenOtherFTL(t *testing.T) {
	fus, tcs, cleanup := setupNTests(t, 2)
	defer cleanup()

	t.Logf("u0 creates a team (seqno:1)")
	teamName, teamID := createTeam2(*tcs[0])

	t.Logf("U0 adds U1 to the team (2)")
	_, err := AddMember(context.TODO(), tcs[0].G, teamName.String(), fus[1].Username, keybase1.TeamRole_ADMIN, nil)
	require.NoError(t, err)

	ctx := context.TODO()
	keyGen := keybase1.PerTeamKeyGeneration(1)

	rotate := func(h bool) {
		g := tcs[0].G
		team, err := GetForTestByID(ctx, g, teamID)
		require.NoError(t, err)
		typ := keybase1.RotationType_VISIBLE
		if h {
			typ = keybase1.RotationType_HIDDEN
		}
		err = team.rotate(ctx, typ)
		require.NoError(t, err)
		keyGen++
	}

	checkForUser := func(i int, forceRefresh bool) {
		mctx := libkb.NewMetaContext(ctx, tcs[i].G)
		arg := keybase1.FastTeamLoadArg{
			ID:            teamID,
			Applications:  []keybase1.TeamApplication{keybase1.TeamApplication_CHAT},
			NeedLatestKey: true,
			ForceRefresh:  forceRefresh,
		}
		team, err := mctx.G().GetFastTeamLoader().Load(mctx, arg)
		require.NoError(t, err)
		require.Equal(t, 1, len(team.ApplicationKeys))
		require.Equal(t, keyGen, team.ApplicationKeys[0].KeyGeneration)
	}

	check := func() {
		checkForUser(0, true)
		checkForUser(1, true)
	}

	for i := 0; i < 5; i++ {
		rotate(i%2 == 0)
		check()
	}

	// Also test the gregor-powered refresh mechanism. We're going to mock out the gregor message for now.
	rotate(true)
	mctx1 := libkb.NewMetaContext(ctx, tcs[1].G)
	err = tcs[1].G.GetHiddenTeamChainManager().HintLatestSeqno(mctx1, teamID, keybase1.Seqno(4))
	require.NoError(t, err)
	checkForUser(1, false)

	ch, err := tcs[1].G.GetHiddenTeamChainManager().Load(mctx1, teamID)
	require.NoError(t, err)
	require.Equal(t, keybase1.Seqno(2), ch.RatchetSet.Ratchets[keybase1.RatchetType_MAIN].Triple.Seqno)
}

func TestRotateHiddenImplicitAdmin(t *testing.T) {
	tc, _, _, _, _, sub := memberSetupSubteam(t)
	defer tc.Cleanup()
	team, err := GetForTestByStringName(context.TODO(), tc.G, sub)
	require.NoError(t, err)
	require.EqualValues(t, 1, team.Generation())
	err = team.Rotate(context.TODO(), keybase1.RotationType_HIDDEN)
	require.NoError(t, err)
}

// Wait for the BG auditor to finish up, and then we'll make sure that the
func pollForTrue(t *testing.T, g *libkb.GlobalContext, poller func(i int) bool) {
	// Hopefully this is enough for slow CI but you never know.
	wait := 10 * time.Millisecond * libkb.CITimeMultiplier(g)
	found := false
	for i := 0; i < 10; i++ {
		if poller(i) {
			found = true
			break
		}
		g.Log.Debug("Didn't get an update; waiting %s more", wait)
		time.Sleep(wait)
		wait *= 2
	}
	require.True(t, found, "whether condition was satisfied after polling ended")
}

func TestHiddenNeedRotate(t *testing.T) {
	fus, tcs, cleanup := setupNTests(t, 2)
	defer cleanup()
	_, bU := fus[0], fus[1]
	aTc, bTc := tcs[0], tcs[1]
	aM, bM := libkb.NewMetaContextForTest(*aTc), libkb.NewMetaContextForTest(*bTc)

	clock := clockwork.NewFakeClockAt(aM.G().Clock().Now())
	aM.G().SetClock(clock)

	t.Logf("A creates team")
	teamName, teamID := createTeam2(*aTc)

	t.Logf("adding B as admin")
	_, err := AddMember(aM.Ctx(), aTc.G, teamName.String(), bU.Username, keybase1.TeamRole_ADMIN, nil)
	require.NoError(t, err)

	t.Logf("B rotates the team once (via hidden)")
	team, err := GetForTestByID(bM.Ctx(), bM.G(), teamID)
	require.NoError(t, err)
	typ := keybase1.RotationType_HIDDEN
	err = team.rotate(bM.Ctx(), typ)
	require.NoError(t, err)

	t.Logf("B adds a paper key so he doesn't go down to 0 keys after revoke")
	uis := libkb.UIs{
		LogUI:    bTc.G.UI.GetLogUI(),
		LoginUI:  &libkb.TestLoginUI{},
		SecretUI: &libkb.TestSecretUI{},
	}
	eng := engine.NewPaperKey(bTc.G)
	err = engine.RunEngine2(bM.WithUIs(uis), eng)
	require.NoError(t, err)

	loadPTKGen := func(m libkb.MetaContext) keybase1.PerTeamKeyGeneration {
		// A now loads the team and it should trigger a BG audit
		team, err := Load(m.Ctx(), m.G(), keybase1.LoadTeamArg{ID: teamID, Public: false, ForceRepoll: true})
		require.NoError(t, err)
		return team.Generation()
	}

	prevGen := loadPTKGen(aM)

	t.Logf("B self-revoke the device that just rotated")
	rEng := engine.NewRevokeDeviceEngine(bM.G(), engine.RevokeDeviceEngineArgs{
		ID:        bM.G().ActiveDevice.DeviceID(),
		ForceSelf: true,
	})
	err = engine.RunEngine2(bM.WithUIs(uis), rEng)
	require.NoError(t, err)

	// Time out the UPAK cache so that now, when we check this user against this team,
	// we'll see that his key is revoked.
	t.Logf("A is checking that the team didn't rotate")
	clock.Advance(libkb.CachedUserTimeout + time.Second)
	genAfterRevoke := loadPTKGen(aM)
	require.Equal(t, prevGen, genAfterRevoke)

	// There's a random backoff before strating the background audit, so advance past that.
	t.Logf("A is checking that eventually he rotates")

	pollForTrue(t, aM.G(), func(i int) bool {
		gen := loadPTKGen(aM)
		return gen > prevGen
	})

	// Allow writes from box auditor to finish up; not really necessary, but makes the logs
	// look nicer.
	time.Sleep(10 * time.Millisecond)
}

// See Y2K-611, the scenario we are testing is:
//
//	visible[1] - root - PTK[1]
//	visible[2] - add member
//	visible[3] - rotate - PTK[2]
//	hidden[1] - rotate - PTK[3]
//
// Now let's say we FTL load this team first, and then full load it. We'll be slotting in
// the PTK at generation 2 after we've loaded PTK at generation 3 via the hidden chain.
func TestHiddenRotateOtherFTLThenSlowLoad(t *testing.T) {

	fus, tcs, cleanup := setupNTests(t, 2)
	defer cleanup()

	t.Logf("u0 creates a team (seqno:1)")
	teamName, teamID := createTeam2(*tcs[0])

	ctx := context.TODO()

	t.Logf("U0 adds U1 to the team (2)")
	_, err := AddMember(ctx, tcs[0].G, teamName.String(), fus[1].Username, keybase1.TeamRole_ADMIN, nil)
	require.NoError(t, err)

	rot := func(typ keybase1.RotationType) {
		team, err := GetForTestByID(ctx, tcs[0].G, teamID)
		require.NoError(t, err)
		err = team.rotate(ctx, typ)
		require.NoError(t, err)
	}

	t.Logf("U0 rotates the team once (via visible)")
	rot(keybase1.RotationType_VISIBLE)
	t.Logf("U0 rotates the team once (via hidden)")
	rot(keybase1.RotationType_HIDDEN)

	mctx := libkb.NewMetaContextForTest(*tcs[1])
	farg := keybase1.FastTeamLoadArg{
		ID:            teamID,
		NeedLatestKey: true,
		Applications:  []keybase1.TeamApplication{keybase1.TeamApplication_CHAT},
	}
	_, err = tcs[1].G.GetFastTeamLoader().Load(mctx, farg)
	require.NoError(t, err)
	team, err := Load(ctx, tcs[1].G, keybase1.LoadTeamArg{ID: teamID, Public: false, ForceRepoll: true})
	require.NoError(t, err)
	require.Equal(t, team.Generation(), keybase1.PerTeamKeyGeneration(3))
}

// See Y2K-679, the scenario we are testing is:
//
//	visible[1] - root - PTK[1]
//	visible[2] - add member
//	hidden[1] - rotate - PTK[2]
//	hidden[2] - rotate - PTK[3]
//	hidden[3] - rotate - PTK[4]
//	hidden[4] - rotate - PTK[5]
//
// Then we:
//   - FTL generations 1,2,4 (leaving a hole at 3)
//   - Full load the team with hidden_low=1 and low=0
func TestHiddenFTLHole(t *testing.T) {

	fus, tcs, cleanup := setupNTests(t, 2)
	defer cleanup()

	t.Logf("u0 creates a team (seqno:1)")
	teamName, teamID := createTeam2(*tcs[0])

	ctx := context.TODO()

	t.Logf("U0 adds U1 to the team (2)")
	_, err := AddMember(ctx, tcs[0].G, teamName.String(), fus[1].Username, keybase1.TeamRole_ADMIN, nil)
	require.NoError(t, err)

	rot := func(typ keybase1.RotationType) {
		team, err := GetForTestByID(ctx, tcs[0].G, teamID)
		require.NoError(t, err)
		err = team.rotate(ctx, typ)
		require.NoError(t, err)
	}

	t.Logf("U0 rotates the team 4x (via hidden)")
	for i := 0; i < 4; i++ {
		rot(keybase1.RotationType_HIDDEN)
	}

	mctx := libkb.NewMetaContextForTest(*tcs[1])
	farg := keybase1.FastTeamLoadArg{
		ID:           teamID,
		Applications: []keybase1.TeamApplication{keybase1.TeamApplication_CHAT},
		KeyGenerationsNeeded: []keybase1.PerTeamKeyGeneration{
			keybase1.PerTeamKeyGeneration(1),
			keybase1.PerTeamKeyGeneration(2),
			keybase1.PerTeamKeyGeneration(4),
		},
	}
	_, err = tcs[1].G.GetFastTeamLoader().Load(mctx, farg)
	require.NoError(t, err)
	team, err := Load(ctx, tcs[1].G, keybase1.LoadTeamArg{ID: teamID, Public: false, ForceRepoll: true})
	require.NoError(t, err)
	require.Equal(t, team.Generation(), keybase1.PerTeamKeyGeneration(5))
}