go/service/config.go - master - githubmirror/client

go/service/config.go
627 строк19 KB
chrisnojima
go startup fixes 1 (#29363)
06 июл 2026, 22:40
06 июл 2026, 22:40609ee62
// Copyright 2019 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package service

import (
	"context"
	"encoding/json"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"time"

	"github.com/keybase/client/go/engine"
	"github.com/keybase/client/go/install"
	"github.com/keybase/client/go/libkb"
	keybase1 "github.com/keybase/client/go/protocol/keybase1"
	"github.com/keybase/client/go/status"
	"github.com/keybase/go-framed-msgpack-rpc/rpc"
	jsonw "github.com/keybase/go-jsonw"
)

type ConfigHandler struct {
	libkb.Contextified
	xp     rpc.Transporter
	svc    *Service
	connID libkb.ConnectionID
}

var _ keybase1.ConfigInterface = (*ConfigHandler)(nil)

func NewConfigHandler(xp rpc.Transporter, i libkb.ConnectionID, g *libkb.GlobalContext, svc *Service) *ConfigHandler {
	return &ConfigHandler{
		Contextified: libkb.NewContextified(g),
		xp:           xp,
		svc:          svc,
		connID:       i,
	}
}

func (h ConfigHandler) GetCurrentStatus(ctx context.Context, sessionID int) (res keybase1.CurrentStatus, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("GetCurrentStatus", &err)()
	return status.GetCurrentStatus(mctx)
}

func (h ConfigHandler) GuiGetValue(ctx context.Context, path string) (ret keybase1.ConfigValue, err error) {
	return h.getValue(ctx, path, h.G().Env.GetGUIConfig())
}

func (h ConfigHandler) GetValue(ctx context.Context, path string) (ret keybase1.ConfigValue, err error) {
	return h.getValue(ctx, path, h.G().Env.GetConfig())
}

func (h ConfigHandler) getValue(_ context.Context, path string, reader libkb.JSONReader) (ret keybase1.ConfigValue, err error) {
	var i any
	i, err = reader.GetInterfaceAtPath(path)
	if err != nil {
		return ret, err
	}
	if i == nil {
		ret.IsNull = true
	} else {
		switch v := i.(type) {
		case int:
			ret.I = &v
		case string:
			ret.S = &v
		case bool:
			ret.B = &v
		case float64:
			tmp := int(v)
			ret.I = &tmp
		default:
			var b []byte
			b, err = json.Marshal(v)
			if err == nil {
				tmp := string(b)
				ret.O = &tmp
			}
		}
	}
	return ret, err
}

func (h ConfigHandler) GuiSetValue(ctx context.Context, arg keybase1.GuiSetValueArg) (err error) {
	return h.setValue(ctx, keybase1.SetValueArg(arg), h.G().Env.GetGUIConfig())
}

func (h ConfigHandler) SetValue(ctx context.Context, arg keybase1.SetValueArg) (err error) {
	return h.setValue(ctx, arg, h.G().Env.GetConfigWriter())
}

func (h ConfigHandler) setValue(_ context.Context, arg keybase1.SetValueArg, w libkb.JSONWriter) (err error) {
	if arg.Path == "users" {
		err = fmt.Errorf("The field 'users' cannot be edited for fear of config corruption")
		return err
	}
	switch {
	case arg.Value.IsNull:
		err = w.SetNullAtPath(arg.Path)
	case arg.Value.S != nil:
		err = w.SetStringAtPath(arg.Path, *arg.Value.S)
	case arg.Value.I != nil:
		err = w.SetIntAtPath(arg.Path, *arg.Value.I)
	case arg.Value.F != nil:
		err = w.SetFloatAtPath(arg.Path, *arg.Value.F)
	case arg.Value.B != nil:
		err = w.SetBoolAtPath(arg.Path, *arg.Value.B)
	case arg.Value.O != nil:
		var jw *jsonw.Wrapper
		jw, err = jsonw.Unmarshal([]byte(*arg.Value.O))
		if err == nil {
			err = w.SetWrapperAtPath(arg.Path, jw)
		}
	default:
		err = fmt.Errorf("Bad type for setting a value")
	}
	if err == nil {
		reloadErr := h.G().ConfigReload()
		if reloadErr != nil {
			h.G().Log.Debug("setValue: error reloading: %+v", reloadErr)
		}
	}
	return err
}

func (h ConfigHandler) GuiClearValue(ctx context.Context, path string) error {
	return h.clearValue(ctx, path, h.G().Env.GetGUIConfig())
}

func (h ConfigHandler) ClearValue(ctx context.Context, path string) error {
	return h.clearValue(ctx, path, h.G().Env.GetConfigWriter())
}

func (h ConfigHandler) clearValue(_ context.Context, path string, w libkb.JSONWriter) error {
	w.DeleteAtPath(path)
	return h.G().ConfigReload()
}

func (h ConfigHandler) GetClientStatus(ctx context.Context, sessionID int) (res []keybase1.ClientStatus, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("GetClientStatus", &err)()
	return libkb.GetClientStatus(mctx), nil
}

func (h ConfigHandler) GetConfig(ctx context.Context, sessionID int) (res keybase1.Config, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("GetConfig", &err)()
	forkType := keybase1.ForkType_NONE
	if h.svc != nil {
		forkType = h.svc.ForkType
	}
	return status.GetConfig(mctx, forkType)
}

func (h ConfigHandler) GetFullStatus(ctx context.Context, sessionID int) (res *keybase1.FullStatus, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("GetFullStatus", &err)()
	return status.GetFullStatus(mctx)
}

func (h ConfigHandler) IsServiceRunning(ctx context.Context, sessionID int) (res bool, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("IsServiceRunning", &err)()

	// set service status
	if mctx.G().Env.GetStandalone() {
		res = false
	} else {
		res = true
	}
	return
}

func (h ConfigHandler) IsKBFSRunning(ctx context.Context, sessionID int) (res bool, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("IsKBFSRunning", &err)()

	clients := libkb.GetClientStatus(mctx)

	kbfs := status.GetFirstClient(clients, keybase1.ClientType_KBFS)

	return kbfs != nil, nil
}

func (h ConfigHandler) GetNetworkStats(ctx context.Context, arg keybase1.GetNetworkStatsArg) (res []keybase1.InstrumentationStat, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("GetNetworkStats", &err)()
	switch arg.NetworkSrc {
	case keybase1.NetworkSource_LOCAL:
		return mctx.G().LocalNetworkInstrumenterStorage.Stats(ctx)
	case keybase1.NetworkSource_REMOTE:
		return mctx.G().RemoteNetworkInstrumenterStorage.Stats(ctx)
	default:
		return nil, fmt.Errorf("Unknown network source %d", arg.NetworkSrc)
	}
}

func (h ConfigHandler) LogSend(ctx context.Context, arg keybase1.LogSendArg) (res keybase1.LogSendID, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer mctx.Trace("LogSend", &err)()

	fstatus, err := status.GetFullStatus(mctx)
	if err != nil {
		return "", err
	}
	statusJSON := status.MergeStatusJSON(fstatus, "fstatus", arg.StatusJSON)

	numBytes := status.LogSendDefaultBytesDesktop
	if arg.SendMaxBytes {
		numBytes = status.LogSendMaxBytes
	}

	// pass empty networkStatsJSON here since we call LogSend with addNetworkStats=true below
	logSendContext := status.NewLogSendContext(h.G(), fstatus, statusJSON, "", arg.Feedback)
	return logSendContext.LogSend(arg.SendLogs, numBytes,
		false /* mergeExtendedStatus */, true /* addNetworkStats */)
}

func (h ConfigHandler) GetAllProvisionedUsernames(ctx context.Context, sessionID int) (res keybase1.AllProvisionedUsernames, err error) {
	defaultUsername, all, err := libkb.GetAllProvisionedUsernames(libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG"))
	if err != nil {
		return res, err
	}

	// If the default is missing, fill it in from the first provisioned.
	if defaultUsername.IsNil() && len(all) > 0 {
		defaultUsername = all[0]
	}
	hasProvisionedUser := !defaultUsername.IsNil()

	// Callers expect ProvisionedUsernames to contain the DefaultUsername, so
	// we ensure it is here as a final sanity check before returning.
	hasDefaultUsername := false
	provisionedUsernames := []string{}
	for _, username := range all {
		provisionedUsernames = append(provisionedUsernames, username.String())
		hasDefaultUsername = hasDefaultUsername || username.Eq(defaultUsername)
	}

	if !hasDefaultUsername && hasProvisionedUser {
		provisionedUsernames = append(provisionedUsernames, defaultUsername.String())
	}

	return keybase1.AllProvisionedUsernames{
		DefaultUsername:      defaultUsername.String(),
		ProvisionedUsernames: provisionedUsernames,
		HasProvisionedUser:   hasProvisionedUser,
	}, nil
}

func (h ConfigHandler) SetUserConfig(ctx context.Context, arg keybase1.SetUserConfigArg) (err error) {
	eng := engine.NewUserConfigEngine(h.G(), &engine.UserConfigEngineArg{
		Key:   arg.Key,
		Value: arg.Value,
	})
	m := libkb.NewMetaContext(ctx, h.G())
	err = engine.RunEngine2(m, eng)
	if err != nil {
		return err
	}
	return nil
}

func (h ConfigHandler) SetPath(_ context.Context, arg keybase1.SetPathArg) error {
	h.G().Log.Debug("SetPath calling mergeIntoPath(%s)", arg.Path)
	return mergeIntoPath(h.G(), arg.Path)
}

func mergeIntoPath(g *libkb.GlobalContext, p2 string) error {
	svcPath := os.Getenv("PATH")
	g.Log.Debug("mergeIntoPath: service path = %s", svcPath)
	g.Log.Debug("mergeIntoPath: merge path   = %s", p2)

	pathenv := filepath.SplitList(svcPath)
	pathset := make(map[string]bool)
	for _, p := range pathenv {
		pathset[p] = true
	}

	var clientAdditions []string
	for _, dir := range filepath.SplitList(p2) {
		if _, ok := pathset[dir]; ok {
			continue
		}
		clientAdditions = append(clientAdditions, dir)
	}

	pathenv = append(pathenv, clientAdditions...)
	combined := strings.Join(pathenv, string(os.PathListSeparator))

	if combined == svcPath {
		g.Log.Debug("No path changes needed")
		return nil
	}

	g.Log.Debug("mergeIntoPath: merged path = %s", combined)
	os.Setenv("PATH", combined)
	return nil
}

func (h ConfigHandler) HelloIAm(_ context.Context, arg keybase1.ClientDetails) error {
	arg.Redact()
	h.G().Log.Debug("HelloIAm: %d - %v", h.connID, arg)
	return h.G().ConnectionManager.Label(h.connID, arg)
}

func (h ConfigHandler) CheckAPIServerOutOfDateWarning(_ context.Context) (keybase1.OutOfDateInfo, error) {
	return h.G().GetOutOfDateInfo(), nil
}

func (h ConfigHandler) GetUpdateInfo(ctx context.Context) (res keybase1.UpdateInfo, err error) {
	mctx := libkb.NewMetaContext(ctx, h.G())
	defer mctx.Trace("GetUpdateInfo", &err)()
	outOfDateInfo := h.G().GetOutOfDateInfo()
	if len(outOfDateInfo.UpgradeTo) != 0 {
		// This is from the API server. Consider client critically out of date
		// if we are asked to upgrade by the API server.
		return keybase1.UpdateInfo{
			Status:  keybase1.UpdateInfoStatus_CRITICALLY_OUT_OF_DATE,
			Message: outOfDateInfo.CustomMessage,
		}, nil
	}
	needUpdate, err := install.GetNeedUpdate() // This is from the updater.
	if err != nil {
		return keybase1.UpdateInfo{
			Status: keybase1.UpdateInfoStatus_UP_TO_DATE,
		}, err
	}
	if needUpdate {
		return keybase1.UpdateInfo{
			Status: keybase1.UpdateInfoStatus_NEED_UPDATE,
		}, nil
	}
	return keybase1.UpdateInfo{
		Status: keybase1.UpdateInfoStatus_UP_TO_DATE,
	}, nil
}

func (h ConfigHandler) StartUpdateIfNeeded(ctx context.Context) error {
	return install.StartUpdateIfNeeded(ctx, h.G().Log)
}

func (h ConfigHandler) WaitForClient(_ context.Context, arg keybase1.WaitForClientArg) (bool, error) {
	return h.G().ConnectionManager.WaitForClientType(arg.ClientType, arg.Timeout.Duration()), nil
}

func (h ConfigHandler) GetBootstrapStatus(ctx context.Context, sessionID int) (res keybase1.BootstrapStatus, err error) {
	m := libkb.NewMetaContext(ctx, h.G()).WithLogTag("CFG")
	defer m.Trace("GetBootstrapStatus", &err)()
	// The GUI gates its first render on this RPC. Wait out the startup login
	// attempt (which can be slow: leveldb open/recovery, keychain reads) so
	// we don't report loggedIn=false while it is still in flight.
	h.svc.awaitInitialLoginAttempt(m, 30*time.Second)
	eng := engine.NewBootstrap(h.G())
	if err = engine.RunEngine2(m, eng); err != nil {
		return res, err
	}
	res = eng.Status()
	m.Debug("GetBootstrapStatus: attempting to get HTTP server address")
	for i := 0; i < 40; i++ { // wait at most 2 seconds
		addr, addrErr := h.svc.httpSrv.Addr()
		if addrErr != nil {
			m.Debug("GetBootstrapStatus: failed to get HTTP server address: %s", addrErr)
		} else {
			m.Debug("GetBootstrapStatus: http server: addr: %s token: %s", addr, h.svc.httpSrv.Token())
			res.HttpSrvInfo = &keybase1.HttpSrvInfo{
				Address: addr,
				Token:   h.svc.httpSrv.Token(),
			}
			break
		}
		time.Sleep(50 * time.Millisecond)
	}
	if res.HttpSrvInfo == nil {
		m.Debug("GetBootstrapStatus: failed to get HTTP srv info after max attempts")
	}
	return res, nil
}

func (h ConfigHandler) RequestFollowingAndUnverifiedFollowers(ctx context.Context, sessionID int) error {
	if err := assertLoggedIn(ctx, h.G()); err != nil {
		return err
	}
	// Queue up a load for follower info
	return h.svc.trackerLoader.Queue(ctx, h.G().ActiveDevice.UID())
}

func (h ConfigHandler) GetRememberPassphrase(ctx context.Context, sessionID int) (bool, error) {
	username := h.G().Env.GetUsername()
	if username.IsNil() {
		h.G().Log.CDebugf(ctx, "GetRememberPassphrase: got nil username; using legacy remember_passphrase setting")
	}
	return h.G().Env.GetRememberPassphrase(username), nil
}

func (h ConfigHandler) SetRememberPassphrase(ctx context.Context, arg keybase1.SetRememberPassphraseArg) error {
	m := libkb.NewMetaContext(ctx, h.G())

	username := m.G().Env.GetUsername()
	if username.IsNil() {
		m.Debug("SetRememberPassphrase: got nil username; using legacy remember_passphrase setting")
	}
	remember, err := h.GetRememberPassphrase(ctx, arg.SessionID)
	if err != nil {
		return err
	}
	if remember == arg.Remember {
		m.Debug("SetRememberPassphrase: no change necessary (remember = %v)", remember)
		return nil
	}

	// set the config variable
	w := h.G().Env.GetConfigWriter()
	if err := w.SetRememberPassphrase(username, arg.Remember); err != nil {
		return err
	}
	err = h.G().ConfigReload()
	if err != nil {
		return err
	}

	if err := h.G().ReplaceSecretStore(ctx); err != nil {
		m.Debug("error replacing secret store for SetRememberPassphrase(%v): %s", arg.Remember, err)
		return err
	}

	m.Debug("SetRememberPassphrase(%s, %v) success", username.String(), arg.Remember)

	return nil
}

type rawGetPkgCheck struct {
	Status libkb.AppStatus      `json:"status"`
	Res    keybase1.UpdateInfo2 `json:"res"`
}

func (r *rawGetPkgCheck) GetAppStatus() *libkb.AppStatus {
	return &r.Status
}

func (h ConfigHandler) GetUpdateInfo2(ctx context.Context, arg keybase1.GetUpdateInfo2Arg) (res keybase1.UpdateInfo2, err error) {
	m := libkb.NewMetaContext(ctx, h.G())

	var version string
	var platform string

	if arg.Platform != nil {
		platform = *arg.Platform
	} else {
		platform = libkb.GetPlatformString()
	}
	if arg.Version != nil {
		version = *arg.Version
	} else {
		version = libkb.VersionString()
	}

	apiArg := libkb.NewRetryAPIArg("pkg/check")
	apiArg.Args = libkb.HTTPArgs{
		"version":  libkb.S{Val: version},
		"platform": libkb.S{Val: platform},
	}
	var raw rawGetPkgCheck
	if err = m.G().API.GetDecode(m, apiArg, &raw); err != nil {
		return res, err
	}
	return raw.Res, nil
}

func (h ConfigHandler) GetProxyData(ctx context.Context) (keybase1.ProxyData, error) {
	config := h.G().Env.GetConfig()
	proxyAddress := config.GetProxy()
	proxyType := libkb.ProxyTypeStrToEnumFunc(config.GetProxyType())
	certPinning := config.IsCertPinningEnabled()

	var convertedProxyType keybase1.ProxyType
	switch proxyType {
	case libkb.NoProxy:
		convertedProxyType = keybase1.ProxyType_No_Proxy
	case libkb.HTTPConnect:
		convertedProxyType = keybase1.ProxyType_HTTP_Connect
	case libkb.Socks:
		convertedProxyType = keybase1.ProxyType_Socks
	default:
		return keybase1.ProxyData{AddressWithPort: "", ProxyType: keybase1.ProxyType_No_Proxy, CertPinning: true},
			fmt.Errorf("Failed to convert proxy type into a protocol compatible proxy type!")
	}

	return keybase1.ProxyData{AddressWithPort: proxyAddress, ProxyType: convertedProxyType, CertPinning: certPinning}, nil
}

func (h ConfigHandler) SetProxyData(ctx context.Context, arg keybase1.ProxyData) error {
	configWriter := h.G().Env.GetConfigWriter()

	rpcProxyType := arg.ProxyType

	var convertedProxyType libkb.ProxyType
	switch rpcProxyType {
	case keybase1.ProxyType_No_Proxy:
		convertedProxyType = libkb.NoProxy
	case keybase1.ProxyType_HTTP_Connect:
		convertedProxyType = libkb.HTTPConnect
	case keybase1.ProxyType_Socks:
		convertedProxyType = libkb.Socks
	default:
		// Got a bogus proxy type that we couldn't convert to a libkb enum so return an error
		return fmt.Errorf("failed to convert given proxy type to a native libkb proxy type")
	}

	proxyTypeStr, ok := libkb.ProxyTypeEnumToStr[convertedProxyType]

	if !ok {
		// Got a bogus proxy type that we couldn't convert to a string
		return fmt.Errorf("failed to convert proxy type into a string")
	}

	err := configWriter.SetStringAtPath("proxy", arg.AddressWithPort)
	if err != nil {
		return err
	}
	err = configWriter.SetBoolAtPath("disable-cert-pinning", !arg.CertPinning)
	if err != nil {
		return err
	}
	err = configWriter.SetStringAtPath("proxy-type", proxyTypeStr)
	if err != nil {
		return err
	}

	// Reload the config file in order to actually start using the proxy
	err = h.G().ConfigReload()
	if err != nil {
		return err
	}

	return nil
}

func (h ConfigHandler) ToggleRuntimeStats(ctx context.Context) error {
	configWriter := h.G().Env.GetConfigWriter()
	curValue := h.G().Env.GetRuntimeStatsEnabled()
	err := configWriter.SetBoolAtPath("runtime_stats_enabled", !curValue)
	if err != nil {
		return err
	}
	if err := h.G().ConfigReload(); err != nil {
		return err
	}
	if curValue {
		<-h.G().RuntimeStats.Stop(ctx)
	} else {
		h.G().RuntimeStats.Start(ctx)
	}
	return nil
}

func (h ConfigHandler) AppendGUILogs(ctx context.Context, content string) error {
	wr := h.G().GetGUILogWriter()
	_, err := io.WriteString(wr, content)
	return err
}

func (h ConfigHandler) GenerateWebAuthToken(ctx context.Context) (ret string, err error) {
	if err := assertLoggedIn(ctx, h.G()); err != nil {
		return ret, err
	}

	nist, err := h.G().ActiveDevice.NISTWebAuthToken(ctx)
	if err != nil {
		return ret, err
	}
	if nist == nil {
		return ret, fmt.Errorf("cannot generate a token when you are logged off")
	}
	uri := libkb.SiteURILookup[h.G().Env.GetRunMode()] + "/_/login/nist?tok=" + nist.Token().String()
	return uri, nil
}

func (h ConfigHandler) UpdateLastLoggedInAndServerConfig(
	ctx context.Context, serverConfigPath string,
) error {
	arg := libkb.APIArg{
		Endpoint:    "user/features",
		SessionType: libkb.APISessionTypeREQUIRED,
	}
	mctx := libkb.NewMetaContext(ctx, h.G())
	resp, err := h.G().API.Get(mctx, arg)
	if err != nil {
		return err
	}
	jw := resp.Body
	isAdmin, err := jw.AtPath("features.admin.value").GetBool()
	if err != nil {
		return err
	}

	// Try to read from the old config file. But ignore any error and just
	// create a new one.
	oldBytes, err := os.ReadFile(serverConfigPath)
	if err != nil {
		jw = jsonw.NewDictionary()
	} else if jw, err = jsonw.Unmarshal(oldBytes); err != nil {
		jw = jsonw.NewDictionary()
	}
	username := h.G().GetEnv().GetUsername().String()
	if err = jw.SetValueAtPath(fmt.Sprintf("%s.chatIndexProfilingEnabled", username), jsonw.NewBool(isAdmin)); err != nil {
		return err
	}
	if err = jw.SetValueAtPath(fmt.Sprintf("%s.dbCleanEnabled", username), jsonw.NewBool(isAdmin)); err != nil {
		return err
	}
	if err = jw.SetValueAtPath(fmt.Sprintf("%s.printRPCStaus", username), jsonw.NewBool(isAdmin)); err != nil {
		return err
	}
	if err = jw.SetKey("lastLoggedInUser", jsonw.NewString(username)); err != nil {
		return err
	}
	newBytes, err := jw.Marshal()
	if err != nil {
		return err
	}
	return libkb.NewFile(serverConfigPath, newBytes, 0o644).Save(h.G().Log)
}